Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v2.0.0 #46

Merged
merged 6 commits into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,37 @@ Sva.Sentinelone Release Notes

.. contents:: Topics

v2.0.0
======

Release Summary
---------------

- Added new agent_info module and merged sentinelone_client_legacy from @stdevel.
- Added new `check_console_retries` and `check_console_retry_delay` in install_agent role.
- Switched to ansible-content-actions in pipelines

Minor Changes
-------------

- Pipelines: Switched ansible-content-actions when performing sanity checks, linting and release to ansible galaxy

Breaking Changes / Porting Guide
--------------------------------

- The download_agent modules `state` parameter is no longer available. If you used `state: info` please use the new agent_info module instead.
- `state` parameter has been removed from download_agent module.

New Modules
-----------

- sva.sentinelone.sentinelone_agent_info - Get info about the SentinelOne agent package

New Roles
---------

- sva.sentinelone.sentinelone_client_legacy - Entrypoint for sentinelone_client_legacy role

v1.1.1
======

Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ It provides several modules which helps to configure and manage SentinelOne Mana
## Included content

- **Modules**:
- [sentinelone_agent_info](https://svalabs.github.io/sva.sentinelone/branch/main/collections/sva/sentinelone/sentinelone_agent_info_module.html)
- [sentinelone_config_overrides](https://svalabs.github.io/sva.sentinelone/branch/main/collections/sva/sentinelone/sentinelone_config_overrides_module.html)
- [sentinelone_download_agent](https://svalabs.github.io/sva.sentinelone/branch/main/collections/sva/sentinelone/sentinelone_download_agent_module.html)
- [sentinelone_filters](https://svalabs.github.io/sva.sentinelone/branch/main/collections/sva/sentinelone/sentinelone_filters_module.html)
Expand Down Expand Up @@ -38,14 +39,15 @@ This collection needs the following Python modules:
## Tested with Ansible and the following Python versions

Tested Ansible versions:
- 2.14
- 2.15
- 2.16
- 2.17

Tested Python versions:
- 3.9
- 3.10
- 3.11
- 3.12

## Using this collection
### Installing the collection from Ansible Galaxy
Expand Down Expand Up @@ -78,7 +80,14 @@ See [Ansible Using collections](https://docs.ansible.com/ansible/devel/user_guid
### User documentation
The module documentation can be found [here](https://svalabs.github.io/sva.sentinelone/branch/main/collections/index_module.html).

The role documentation can be found [here](https://svalabs.github.io/sva.sentinelone/branch/main/collections/index_role.html).

## Changelog
**v2.0.0**:
- Added new sentinelone_agent_info module and [@stdevels](https://github.com/stdevel/ansible-sentinelone_client) sentinelone_client role as sentinelone_client_legacy.
- install_agent role: Added configurable retries and delays in the step which checks if the agent appears in the management console.
- **Breaking Changes**: The download_agent modules `state` parameter is no longer available. If you used `state: info` please use the new agent_info module instead. `state` parameter has been removed from download_agent module.

**v1.1.1**: Bugfix release. Changed privilege escalation behaviour

**v1.1.0**: Added new sentinelone_download_agent module and install_agent role
Expand Down
20 changes: 18 additions & 2 deletions changelogs/.plugin-cache.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
objects: {}
objects:
role:
install_agent:
description: Entrypoint for install_agent role
name: install_agent
version_added: null
sentinelone_client_legacy:
description: Entrypoint for sentinelone_client_legacy role
name: sentinelone_client_legacy
version_added: 2.0.0
plugins:
become: {}
cache: {}
callback: {}
cliconf: {}
connection: {}
filter: {}
httpapi: {}
inventory: {}
lookup: {}
module:
sentinelone_agent_info:
description: Get info about the SentinelOne agent package
name: sentinelone_agent_info
namespace: ''
version_added: 2.0.0
sentinelone_config_overrides:
description: Manage SentinelOne Config Overrides
name: sentinelone_config_overrides
Expand Down Expand Up @@ -52,5 +67,6 @@ plugins:
netconf: {}
shell: {}
strategy: {}
test: {}
vars: {}
version: 1.1.1
version: 2.0.0
38 changes: 35 additions & 3 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
ancestor: null
releases:
1.0.0:
Expand Down Expand Up @@ -71,19 +72,50 @@ releases:
namespace: ''
objects:
role:
- description: A role to download and install SentinelAgent on Windows and Linux
hosts
- description: A role to download and install SentinelAgent on Windows and
Linux hosts
name: install_agent
namespace: null
release_date: '2024-03-14'
1.1.1:
changes:
bugfixes:
- 'install_agent role: Added ''become: true'' to necessary linux tasks. It
is no longer necessary to use ''become: true'' on playbook level. Fixes https://github.com/svalabs/sva.sentinelone/issues/30'
is no longer necessary to use ''become: true'' on playbook level. Fixes
https://github.com/svalabs/sva.sentinelone/issues/30'
- 'install_agent role: Added missing ''urlencode'' filter so special characters
like space can be used in site or group names. Fixes https://github.com/svalabs/sva.sentinelone/issues/28'
release_summary: Maintenance release
fragments:
- v1.1.1.yml
release_date: '2024-05-27'
2.0.0:
changes:
breaking_changes:
- 'The download_agent modules `state` parameter is no longer available. If
you used `state: info` please use the new agent_info module instead.'
- '`state` parameter has been removed from download_agent module.'
minor_changes:
- 'Pipelines: Switched ansible-content-actions when performing sanity checks,
linting and release to ansible galaxy'
release_summary: '- Added new agent_info module and merged sentinelone_client_legacy
from @stdevel.

- Added new `check_console_retries` and `check_console_retry_delay` in install_agent
role.

- Switched to ansible-content-actions in pipelines

'
fragments:
- v2.0.0.yml
modules:
- description: Get info about the SentinelOne agent package
name: sentinelone_agent_info
namespace: ''
objects:
role:
- description: Entrypoint for sentinelone_client_legacy role
name: sentinelone_client_legacy
namespace: null
release_date: '2024-09-26'
1 change: 1 addition & 0 deletions changelogs/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ sections:
title: Sva.Sentinelone
trivial_section_name: trivial
use_fqcn: true
changelog_nice_yaml: true
7 changes: 5 additions & 2 deletions galaxy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace: "sva"
name: "sentinelone"

# The version of the collection. Must be compatible with semantic versioning
version: "1.1.1"
version: "2.0.0"

# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
readme: "README.md"
Expand All @@ -34,17 +34,20 @@ license_file: "LICENSE"
# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
# requirements as 'namespace' and 'name'
tags:
- agent
- application
- install_agent
- security
- sentinelone
- sentinelone_client
- sentinelone_client_legacy
- sentinelone_config_overrides
- sentinelone_filters
- sentinelone_groups
- sentinelone_path_exclusions
- sentinelone_policies
- sentinelone_sites
- sentinelone_upgrade_policies
- install_agent

dependencies:
ansible.windows: "*"
Expand Down
3 changes: 3 additions & 0 deletions roles/install_agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ Required for .rpm based systems when agent version >= 23.3.2.12.

**Windows:** _ansible_user_ has to be an administrator account. Therefore no privilege escalation is needed.

### Role Documentation
A **[HTML documentation](https://svalabs.github.io/sva.sentinelone/branch/main/collections/sva/sentinelone/install_agent_role.html)** in the usual Ansible documentation format can be found [here](https://svalabs.github.io/sva.sentinelone/branch/main/collections/sva/sentinelone/install_agent_role.html).

Role Variables
--------------

Expand Down
5 changes: 4 additions & 1 deletion roles/sentinelone_client_legacy/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# sentinelone_client_legacy (Alias: sentinelone_client)
# sentinelone_client_legacy

**This role was merged to this collection from the Ansible role [sentinelone_client](https://github.com/stdevel/ansible-sentinelone_client) by [@stdevel](https://github.com/stdevel).**

Expand All @@ -22,6 +22,9 @@ No requirements.

No dependencies.

### Role Documentation
A **[HTML documentation](https://svalabs.github.io/sva.sentinelone/branch/main/collections/sva/sentinelone/sentinelone_client_legacy.html)** in the usual Ansible documentation format can be found [here](https://svalabs.github.io/sva.sentinelone/branch/main/collections/sva/sentinelone/sentinelone_client_legacy.html).

## Example Playbook

```yml
Expand Down
30 changes: 30 additions & 0 deletions roles/sentinelone_client_legacy/meta/argument_specs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
argument_specs:
# roles/sentinelone_client_legacy/tasks/main.yml entry point
main:
short_description: "Entrypoint for sentinelone_client_legacy role"
version_added: 2.0.0
description:
- "This is the main entrypoint for the C(sentinelone_client_legacy) role."
- "The entrypoint contains all os independent tasks and prepares the environment
for the os specific tasks."
author:
- Christian Stankovic
options:
sentinelone_client_filename:
type: "str"
required: true
description:
- "Package file to install"

sentinelone_client_token:
type: "str"
required: true
description:
- "Group/Site token"

sentinelone_client_gpgkey:
type: "str"
required: false
description:
- "GPG signing key to import"
Loading