Ansible Collection - community.es

This repository has been archived. Refer to the splunk.es collection repository instead.

This repo hosts the community.es Ansible Collection.

The collection includes the community plugins to help the automation of Splunk Enterprise Security SIEM Platform.

Installation and Usage

Installing the Collection from Ansible Galaxy

Before using the Community Splunk Enterprise Secuirty collection, you need to install it with the ansible-galaxy CLI:

ansible-galaxy collection install community.es

You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml using the format:

collections:
- name: community.es

Testing and Development

If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configured COLLECTIONS_PATHS, and work on it there.

Testing with ansible-test

The tests directory contains configuration for running sanity and integration tests using ansible-test.

You can run the collection's test suites with the commands:

ansible-test sanity
ansible-test network-integration --inventory /path/to/inventory

Publishing New Version

The current process for publishing new versions of the Splunk Enterprise Security Community Collection is manual, and requires a user who has access to the community namespace on Ansible Galaxy to publish the build artifact.

1. Ensure CHANGELOG.md contains all the latest changes.

2. Update galaxy.yml with the new version for the collection.

3. Create a release in GitHub to tag the commit at the version to build.

4. Run the following commands to build and release the new version on Galaxy:

   ansible-galaxy collection build
   ansible-galaxy collection publish ./community-es-$VERSION_HERE.tar.gz
   

After the version is published, verify it exists on the Splunk Enterprise Security Community Collection Galaxy page.

More Information

For more information about Ansible's Splunk Enterprise Security integration, join the #ansible-security channel on libera.chat IRC, and browse the resources in the Security Automation Working Group Community wiki page.

License

GNU General Public License v3.0 or later

See COPYING to see the full text.