An Ansible Role to create rulebook activations in EDA Controller.
Variables
Variable Name
Default Value
Required
Description
Example
platform_state
“present”
no
The state all objects will take unless overridden by object default
‘absent’
aap_hostname
””
yes
URL to the Ansible Automation Platform Server.
127.0.0.1
aap_validate_certs
True
no
Whether or not to validate the Ansible Automation Platform Server’s SSL certificate.
aap_username
””
no
Admin User on the Ansible Automation Platform Server. Either username / password or oauthtoken need to be specified.
aap_password
””
no
Platform Admin User’s password on the Server. This should be stored in an Ansible Vault at vars/platform-secrets.yml or elsewhere and called from a parent playbook.
aap_token
””
no
Controller Admin User’s token on the Ansible Automation Platform Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.
aap_request_timeout
10
no
Specify the timeout in seconds Ansible should use in requests to the controller host.
eda_rulebook_activations
see below
yes
Data structure describing your users Described below.
Secure Logging Variables
The following Variables compliment each other. If Both variables are not set, secure logging defaults to false. The role defaults to False as normally the add group_roles task does not include sensitive information. eda_configuration_rulebook_activations_secure_logging defaults to the value of aap_configuration_secure_logging if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of automation hub configuration roles with a single variable, or for the user to selectively use it.
Whether or not to include the sensitive Registry role tasks in the log. Set this value to True if you will be providing your sensitive values from elsewhere.
aap_configuration_secure_logging
False
no
Whether or not to include the sensitive Registry role tasks in the log. Set this value to True if you will be providing your sensitive values from elsewhere.
Asynchronous Retry Variables
The following Variables set asynchronous retries for the role. If neither of the retries or delay or retries are set, they will default to their respective defaults. This allows for all items to be created, then checked that the task finishes successfully. This also speeds up the overall role.
Variable Name
Default Value
Required
Description
aap_configuration_async_retries
50
no
This variable sets the number of retries to attempt for the role globally.
Sets the directory to write the results file for async tasks. The default value is set to null which uses the Ansible Default of /root/.ansible_async/.
Data Structure
Rulebook activation Variables
Variable Name
Default Value
Required
Type
Description
name
””
yes
str
Rulebook activation name. Must be lower case containing only alphanumeric characters and underscores.
description
””
no
str
Description to use for the Activation.
project
””
no
str
Project to use for the Activation.
rulebook
””
yes
str
rulebook to use for the Activation.
decision_environment
””
yes
str
Decision_environment to use for the Activation.
restart_policy
“always”
no
str
Restart_policy to use for the Activation, choice of [“always”, “never”, “on-failure”]
extra_vars
””
no
str
Extra_vars to use for the Activation.
awx_token
””
no
str
The token used to authenticate to controller.
enabled
“true”
no
str
Whether the rulebook activation is automatically enabled to run.
state
present
no
str
Desired state of the rulebook activation.
organization
””
no
str
The name of the organization.
eda_credentials
””
no
list
A list of IDs for EDA credentials used by the rulebook activation.
k8s_service_name
””
no
str
The name of the Kubernetes service associated with this rulebook activation.
swap_single_source
“true”
no
bool
Allow swapping of single sources in a rulebook without name match.
event_streams
””
no
list
A list of event stream names that this rulebook activation listens to.
log_level
””
no
str
Allow setting the desired log level.
Standard rulebook activation Data Structure
Yaml Example
eda_rulebook_activations:-name:Github Hookdescription:Hook to listen for changes in GitHubproject:EDA_examplerulebook:git-hook-deploy-rules.ymldecision_environment:Automation Hub Default Decision Environmentextra_vars:provider:github-localrepo_url:https://github.com/ansible/ansible-rulebook.gitenabled:falsestate:present
Playbook Examples
Standard Role Usage
-name:Add rulebook activation to EDA Controllerhosts:localhostconnection:localgather_facts:falsevars:eda_validate_certs:false# Define following vars here, or in eda_configs/eda_auth.yml# controller_host: ansible-eda-web-svc-test-project.example.com# eda_token: changemepre_tasks:-name:Include vars from eda_configs directoryansible.builtin.include_vars:dir:./varsextensions:["yml"]tags:-alwaysroles:-../../eda_rulebook_activations