Ansible Role infra.aap_configuration.http_ports

Description

An Ansible Role to add proxy Http Ports on Ansible Automation gateway.

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 Ansible Automation Platform host.
`gateway_http_ports`	`see below`	yes	Data structure describing your http_ports entries 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 ee_registry task does not include sensitive information. gateway_http_ports_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.

Variable Name	Default Value	Required	Description
`gateway_http_ports_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.
`aap_configuration_secure_logging`	`false`	no	This variable enables secure logging as well, but is shared across multiple roles, see above.

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.
`gateway_http_ports_async_retries`	`aap_configuration_async_retries`	no	This variable sets the number of retries to attempt for the role.
`aap_configuration_async_delay`	1	no	This sets the delay between retries for the role globally.
`gateway_http_ports_hosts_async_delay`	`aap_configuration_async_delay`	no	This sets the delay between retries for the role.
`aap_configuration_loop_delay`	1000	no	This variable sets the loop_delay for the role globally.
`gateway_http_ports_loop_delay`	`aap_configuration_loop_delay`	no	This variable sets the loop_delay for the role.
`aap_configuration_async_dir`	`null`	no	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

Http Port Arguments

Options for the http_ports_list variable:

Variable Name	Default Value	Required	Type	Description
`name`	N/A	yes	str	The name of the resource
`new_name`	N/A	no	str	Setting this option will change the existing name (looked up via the name field)
`number`	N/A	no	int	Port number, must be unique
`use_https`	`false`	no	bool	Secure this port with HTTPS
`is_api_port`	`false`	no	bool	If true, port is used for serving remote AAP APIs. Only one can be set to true
`state`	`present`	no	str	Desired state of the resource.

Unique value:

name
number

Usage

Json Example

Create or update the proxy http port 443, renames it to “Proxy API Port”

{
  "gateway_http_ports": [
    {
      "name": "API port",
      "new_name": "Proxy API port",
      "number": 443,
      "is_api_port": true,
      "use_https": true
    }
  ]
}

Yaml Example

Delete port (if exists) 8001
Create port (if not exists) 8002
Create or update port 8003

File name: data/gateway_http_ports.yml

gateway_http_ports:
- name: "Service Port 8001"
  number: 8001
  state: absent
- name: "Reserved port"
  number: 8002
- name: "Backup port"
  number: 8003
  use_https: true

License

GPL-3.0