Event-Driven Ansible controller variables

Inventory file variables for Event-Driven Ansible controller.

Expand
Variable name Description Required or optional Default

eda_activation_workers

Number of workers used for ansible-rulebook activation pods in Event-Driven Ansible.

Optional

2

eda_admin_email

Email address used by Django for the admin user for Event-Driven Ansible.

Optional

admin@example.com

eda_admin_password

Event-Driven Ansible administrator password. Use of special characters for this variable is limited. The password can include any printable ASCII character except /, ", or @.

Required

eda_admin_user

Username used to identify and create the administrator user in Event-Driven Ansible.

Optional

admin

eda_debug

Controls whether debug mode is enabled or disabled for Event-Driven Ansible. Set to true to enable debug mode for Event-Driven Ansible.

Optional

false

eda_event_stream_mtls

Controls whether event stream mutual TLS (mTLS) authentication is enabled or disabled for Event-Driven Ansible. Set this variable to false to disable mTLS authentication.

Optional

true

eda_event_stream_mtls_prefix_path

The prefix path for the event stream mTLS URLs.

Optional

/mtls/eda-event-streams

eda_event_stream_prefix_path

API prefix path used for Event-Driven Ansible event-stream through platform gateway.

Optional

/eda-event-streams

eda_event_stream_url

URL for connecting to the event stream. The URL must start with the http:// or https:// prefix

Optional

eda_extra_settings

Defines additional settings for use by Event-Driven Ansible during installation.

For example:

eda_extra_settings=[{"setting": "RULEBOOK_READINESS_TIMEOUT_SECONDS", "value": 120}]

Optional

[]

eda_firewall_zone

The firewall zone where Event-Driven Ansible related firewall rules are applied. This controls which networks can access Event-Driven Ansible based on the zone's trust level.

Optional

public

eda_gunicorn_workers

The number of Gunicorn worker processes to spawn for the Event-Driven Ansible controller API. Increasing this value improves the controller's ability to handle concurrent API requests and user interface interactions.

Optional

(Number of cores or threads) * 2 + 1
eda_gunicorn_timeout The amount of time, in seconds, that a Gunicorn worker waits for an API request to complete before timing out and restarting. Increasing this value can prevent timeouts for long-running API operations. Optional 10
eda_gunicorn_timeout_grace_period The amount of time, in seconds, a Gunicorn worker has to finish processing requests after a timeout or restart signal is received. This provides a buffer for workers to exit gracefully before being forcibly terminated. Optional 2

eda_nginx_client_max_body_size

Maximum allowed size for data sent to Event-Driven Ansible through NGINX.

Optional

1m

eda_nginx_disable_hsts

Controls whether HTTP Strict Transport Security (HSTS) is enabled or disabled for Event-Driven Ansible. Set this variable to true to disable HSTS.

Optional

false

eda_nginx_disable_https

Controls whether HTTPS is enabled or disabled for Event-Driven Ansible. Set this variable to true to disable HTTPS.

Optional

false

eda_nginx_hsts_max_age

Maximum duration (in seconds) that HTTP Strict Transport Security (HSTS) is enforced for Event-Driven Ansible.

Optional

63072000

eda_nginx_http_port

Port number that Event-Driven Ansible listens on for HTTP requests.

Optional

8082

eda_nginx_https_port

Port number that Event-Driven Ansible listens on for HTTPS requests.

Optional

8445

eda_nginx_https_protocols

Protocols that Event-Driven Ansible supports when handling HTTPS traffic.

Optional

[TLSv1.2, TLSv1.3]

eda_nginx_user_headers

List of additional NGINX headers to add to Event-Driven Ansible's NGINX configuration.

Optional

[]

eda_pg_cert_auth

Controls whether client certificate authentication is enabled or disabled on the Event-Driven Ansible PostgreSQL database. Set this variable to true to enable client certificate authentication.

Optional

false

eda_pg_database

Name of the PostgreSQL database used by Event-Driven Ansible.

Optional

eda

eda_pg_host

Hostname of the PostgreSQL database used by Event-Driven Ansible.

Required

eda_pg_password

Password for the Event-Driven Ansible PostgreSQL database user. Use of special characters for this variable is limited. The !, #, 0 and @ characters are supported. Use of other special characters can cause the setup to fail.

Required if not using client certificate authentication.

eda_pg_port

Port number for the PostgreSQL database used by Event-Driven Ansible.

Optional

5432

eda_pg_socket

UNIX socket used by Event-Driven Ansible to connect to the PostgreSQL database.

Optional

eda_pg_sslmode

Determines the level of encryption and authentication for client server connections. Valid options include verify-full, verify-ca, require, prefer, allow, disable.

Optional

prefer

eda_pg_tls_cert

Path to the PostgreSQL SSL/TLS certificate file for Event-Driven Ansible.

Required if using client certificate authentication.

eda_pg_tls_key

Path to the PostgreSQL SSL/TLS key file for Event-Driven Ansible.

Required if using client certificate authentication.

eda_pg_username

Username for the Event-Driven Ansible PostgreSQL database user.

Optional

eda

eda_redis_disable_tls

Controls whether TLS is enabled or disabled for Event-Driven Ansible Redis. Set this variable to true to disable TLS.

Optional

false

eda_redis_host

Hostname of the Redis host used by Event-Driven Ansible.

Optional

First node in the [automationgateway] inventory group

eda_redis_password

Password for Event-Driven Ansible Redis.

Optional

Randomly generated string

eda_redis_port

Port number for the Redis host for Event-Driven Ansible.

Optional

6379

eda_redis_tls_cert

Path to the Event-Driven Ansible Redis certificate file.

Optional

eda_redis_tls_key

Path to the Event-Driven Ansible Redis key file.

Optional

eda_redis_username

Username for Event-Driven Ansible Redis.

Optional

eda

eda_safe_plugins

List of plugins that are allowed to run within Event-Driven Ansible.

Optional

[]

eda_secret_key

Secret key value used by Event-Driven Ansible to sign and encrypt data.

Optional

eda_tls_cert

Path to the SSL/TLS certificate file for Event-Driven Ansible.

Optional

eda_tls_key

Path to the SSL/TLS key file for Event-Driven Ansible.

Optional

eda_tls_remote

Denote whether the Event-Driven Ansible provided certificate files are local to the installation program (false) or on the remote component server (true).

Optional

false

eda_type

Event-Driven Ansible node type. Valid options include api, event-stream, hybrid, worker.

Optional

hybrid

eda_use_archive_compression

Enables or disables compression for project and rulebook archives to reduce storage usage and network overhead during task execution. This can be overridden globally by the use_archive_compression variable.

Optional

true

eda_use_db_compression

Controls whether database compression is enabled or disabled for Event-Driven Ansible. You can control this functionality globally by using use_db_compression.

Optional

true

eda_workers

The number of worker processes to spawn for the Event-Driven Ansible controller. Increasing this value allows for more concurrent rulebook activations and background tasks.

Optional

Number of cores or threads
eda_event_stream_mtls_url The URL used for Mutual TLS (mTLS) authentication when connecting event streams to the Event-Driven Ansible controller. Optional Gateway proxy URL
eda_event_stream_pg_username The PostgreSQL account name for authenticating Event-Driven Ansible event stream database operations. Optional eda_event_stream
eda_event_stream_pg_password The password used to authenticate with the PostgreSQL database dedicated to Event-Driven Ansible event streams. Note
If you do not define a password, one will be automatically generated for you.
Optional
eda_event_stream_pg_cert_auth Enables or disables certificate-based authentication for the PostgreSQL database connection used for Event-Driven Ansible event streams instead of a password. Optional false
eda_event_stream_pg_tls_cert The client certificate used for TLS authentication between the Event-Driven Ansible event stream service and the PostgreSQL database. Optional
eda_event_stream_pg_tls_key The private key associated with the TLS certificate used to authenticate the Event-Driven Ansible event stream service with the PostgreSQL database. Optional
eda_event_stream_pg_sslmode

The SSL connection mode used to determine the security level of the TLS connection between the Event-Driven Ansible event stream service and the PostgreSQL database.

For supported values, see the .PostgreSQL SSL Mode Documentation		 Optional prefer