Red Hat Ansible Automation Platform 安装指南

enable_insights_collection

如果节点使用 Subscription Manager 注册，则默认安装会将节点注册到 Red Hat Ansible Automation Platform Service 中。设置为 False 以禁用。

默认为 true

registry_password

只有在使用非捆绑包安装程序时，才需要 registry_password。

用于访问 registry_url 的密码凭证。

用于 [automationcontroller] 和 [automationhub] 组。

在 registry_username 和 registry_password 中输入 Red Hat Registry Service account 凭证以链接到 Red Hat 容器 registry。

当 registry_url 为 registry.redhat.io 时，如果没有使用捆绑安装程序，则需要用户名和密码。

registry_url

用于 [automationcontroller] 和 [automationhub] 组。

默认为 registry.redhat.io。

registry_username

只有在使用非捆绑包安装程序时，才需要 registry_username。

用于访问 registry_url 的用户权限。

用于 [automationcontroller] 和 [automationhub] 组，但只有 registry_url 的值为 registry.redhat.io 时才使用。

在 registry_username 和 registry_password 中输入 Red Hat Registry Service account 凭证以链接到 Red Hat 容器 registry。

routable_hostname

如果运行安装程序的机器只能通过特定 URL 路由到目标主机，例如，如果您的清单中使用短名称，但运行安装程序的节点只能解析使用 FQDN 的主机时，使用 routable hostname。

如果没有设置 routable_hostname，它应默认为 ansible_host。然后，如果没有且只没有设置 ansible_host 时，inventory_hostname 才用作最后的手段。

请注意，此变量用作特定主机的主机变量，而不在 [all:vars] 部分下。如需更多信息，请参阅 将变量分配给一个 machine:host 变量

automationhub_admin_password

必填

automationhub_api_token

如果从 Ansible Automation Platform 2.0 或更早版本升级，您必须：

生成新令牌会导致现有令牌无效。

automationhub_authentication_backend

默认不设置此变量。将它设置为 ldap 以使用 LDAP 身份验证。

当它被设置为 ldap 时，还必须设置以下变量：

automationhub_auto_sign_collections

如果启用了集合签名服务，则集合默认不会自动签名。

将此参数设置为 true 默认禁用它们。

默认为 false。

automationhub_backup_collections

可选

Ansible Automation hub 在 /var/lib/pulp 中提供工件。自动化控制器默认自动备份工件。

您还可以设置 automationhub_backup_collections = false，备份/恢复 进程不会备份或恢复 /var/lib/pulp。

默认为 true

automationhub_collection_seed_repository

当捆绑包安装程序运行时，验证的内容将上传到 validated 存储库，认证的内容将上传到 rh-certified 存储库。

默认情况下，经过认证和验证的内容都会被上传。

此变量的可能值为 'certified' 或 'validated'。

如果您不想安装内容，请将 automationhub_seed_collections 设置为 false 来禁用 seeding。

如果您只需要一种类型的内容，请将 automationhub_seed_collections 设置为 true，将 automationhub_collection_seed_repository 设置为您要包含的内容类型。

automationhub_collection_signing_service_key

如果启用了集合签名服务，您必须提供此变量，以确保可以正确签名集合。

/absolute/path/to/key/to/sign

automationhub_collection_signing_service_script

如果启用了集合签名服务，您必须提供此变量，以确保可以正确签名集合。

/absolute/path/to/script/that/signs

automationhub_create_default_collection_signing_service

默认安装不会创建签名服务。如果设置为 true，则创建签名服务。

默认为 false

automationhub_container_signing_service_key

如果启用了容器签名服务，您必须提供此变量，以确保容器可以被正确签名。

/absolute/path/to/key/to/sign

automationhub_container_signing_service_script

如果启用了集合签名服务，您必须提供此变量，以确保容器可以被正确签名。

/absolute/path/to/script/that/signs

automationhub_create_default_contaier_signing_service

默认安装不会创建签名服务。如果设置为 true，则创建签名服务。

默认为 false

automationhub_disable_hsts

默认安装部署一个启用了 TLS 的 Ansible Automation hub。如果 Automation hub 部署了启用了 HTTP Strict Transport Security (HSTS) web-security 策略的自动化中心。除非另有指定，否则启用 HSTS web-security 策略机制。如果需要，此设置允许您禁用此设置。

默认为 false

automationhub_disable_https

可选

如果 Ansible Automation hub 部署启用了 HTTPS。

默认为 false。

automationhub_enable_api_access_log

当设置为 true 时，在 /var/log/galaxy_api_access.log 中创建一个日志文件，该文件会记录提供给平台的所有用户操作，包括其用户名和 IP 地址

默认为 false。

automationhub_enable_analytics

指明是否为 Ansible Automation Platform 2.3 中自动化中心中使用的 pulpcore 版本启用 Pulp 分析的布尔值。

要启用 pulp 分析，请设置 automationhub_enable_analytics = true。

默认为 false。

automationhub_enable_unauthenticated_collection_access

启用未授权用户查看集合。

要启用未授权用户查看集合，请设置 automationhub_enable_unauthenticated_collection_access = true。

默认为 false。

automation_hub_enable_unauthenticated_collection_download

启用未授权用户下载集合。

要启用未授权用户下载集合，请设置 automationhub_enable_unauthenticated_collection_download = true。

默认为 false。

automationhub_importer_settings

可选

传递给 galaxy-importer 的设置字典。

在导入时，集合可以通过一系列检查。

行为由 galaxy-importer.cfg 配置驱动。

例如 ansible-doc、ansible-lint 和 flake8。

这个参数可让您驱动此配置。

automationhub_main_url

客户端连接到的主 {HubNameShort} URL。

例如： https://<load balancer host>。

如果没有指定，则使用 [automationhub] 组中的第一个节点。

如果要在自动化中心环境中实施 Red Hat Single Sign-On，使用 automationhub_main_url 指定客户端连接到的主自动化中心 URL。

automationhub_pg_database

必需

数据库名称。

默认为 automationhub

automationhub_pg_host

如果不使用内部数据库，则需要此项。

automationhub_pg_password

Automation hub PostgreSQL 数据库的密码。

不要对 automationhub_pg_password 使用特殊字符。它们可能会导致密码失败。

automationhub_pg_port

如果不使用内部数据库，则需要此项。

默认 = 5432

automationhub_pg_sslmode

必需。

默认为 prefer

automationhub_pg_username

必填

默认为 automationhub

automationhub_require_content_approval

可选

如果自动化中心在集合可用前强制实施批准机制。

默认情况下，当您将集合上传到自动化中心时，管理员必须批准它，然后供用户使用。

如果要禁用内容批准流，请将变量设置为 false。

默认为 true

automationhub_seed_collections

定义是否启用预加载的布尔值。

当捆绑包安装程序运行时，默认情况下，新存储库会在名为 validated' 的私有自动化中心中创建，并更新验证的集合列表。

如果您不想安装内容，请将 automationhub_seed_collections 设置为 false 来禁用 seeding。

如果您只需要一种类型的内容，请将 automationhub_seed_collections 设置为 true，将 automationhub_collection_seed_repository 设置为您要包含的内容类型。

默认为 true

automationhub_ssl_cert

可选

/path/to/automationhub.cert 与 web_server_ssl_cert 相同，但用于自动化中心 UI 和 API

automationhub_ssl_key

可选

/path/to/automationhub.key

与 web_server_ssl_key 相同，但用于自动化 hub UI 和 API

automationhub_ssl_validate_certs

对于 Red Hat Ansible Automation Platform 2.3 及更新的版本，不再使用这个值。

如果自动化中心因为默认设置，在请求自身时需要验证证书，则 Ansible Automation Platform 会使用自签名证书部署。

默认为 false。

automationhub_upgrade

已弃用

对于 Ansible Automation Platform 2.2.1 及更新的版本，它的值已固定为 true。

Automation hub 始终使用最新的软件包进行更新。

generate_automationhub_token

如果从 Red Hat Ansible Automation Platform 2.0 或更早版本进行升级，您必须：

nginx_hsts_max_age

此变量指定系统应被视为 HTTP Strict Transport Security (HSTS)主机的时间（以秒为单位）。也就是 HTTPS 专用于通信的时间。

默认为 63072000 秒，或两年。

nginx_tls_protocols

定义 Nginx 中对 ssl_protocols 的支持。

默认为 TLSv1.2。

pulp_db_fields_key

您要导入的 Fernet 对加密密钥的相对或绝对路径。该路径位于 Ansible 管理节点上。它用于加密数据库中的某些字段（如凭证）。如果未指定，将生成一个新密钥。

automationhub_ldap_bind_dn

使用 automationhub_ldap_bind_password 绑定到 LDAP 服务器时使用的名称。

automationhub_ldap_bind_password

必需

与 automationhub_ldap_bind_dn 搭配使用的密码。

automationhub_ldap_group_search_base_dn

一个 LDAPSearch 对象，用于查找用户可能属于的所有 LDAP 组。如果您的配置对 LDAP 组有任何引用，则必须设置此 和 automationhub_ldap_group_type。

默认为 None

automatiohub_ldap_group_search_filter

可选

用于查找组成员资格的搜索过滤器。

变量标识了使用自动化中心和 LDAP 映射组要使用哪个 flavor 类型。用于通过 LDAP 安装自动化中心。

默认为 (objectClass=Group)

automationhub_ldap_group_search_scope

可选

范围使用 django 框架用于 LDAP 身份验证在 LDAP 树中搜索组。用于通过 LDAP 安装自动化中心。

默认为 SUBTREE

automationhub_ldap_group_type_class

可选

变量标识在 django 框架内用于 LDAP 身份验证的组类型。用于通过 LDAP 安装自动化中心。

Default =django_auth_ldap.config:GroupOfNamesType

automationhub_ldap_server_uri

LDAP 服务器的 URI。这可以是底层 LDAP 库支持的任何 URI。

automationhub_ldap_user_search_base_dn

在目录中查找用户的 LDAPSearch 对象。filter 参数应包含用户名的占位符 %(user)。它必须完全返回一个结果才能成功进行身份验证。

automationhub_ldap_user-search_scope

可选

范围使用 django 框架用于 LDAP 身份验证在 LDAP 树中搜索用户。用于通过 LDAP 安装自动化中心。

默认为 'SUBTREE

sso_automation_platform_login_theme

可选

用于 Ansible Automation Platform 管理的和外部管理的 Red Hat Single Sign-On。

主题文件所在的目录的路径。如果更改此变量，您必须提供自己的主题文件。

默认 = ansible-automation-platform

sso_automation_platform_realm

可选

用于 Ansible Automation Platform 管理的和外部管理的 Red Hat Single Sign-On。

SSO 中域的名称。

默认 = ansible-automation-platform

sso_automation_platform_realm_displayname

可选

用于 Ansible Automation Platform 管理的和外部管理的 Red Hat Single Sign-On。

显示域的名称。

默认 = Ansible Automation Platform

sso_console_admin_username

可选

用于 Ansible Automation Platform 管理的和外部管理的 Red Hat Single Sign-On。

SSO 管理用户名。

默认 = admin

sso_console_admin_password

必需

用于 Ansible Automation Platform 管理的和外部管理的 Red Hat Single Sign-On。

SSO 管理密码。

sso_custom_keystore_file

可选

仅用于 Ansible Automation Platform 管理的 Red Hat Single Sign-On。

为 SSO 提供客户提供的密钥存储。

sso_host

必需

仅用于外部管理的 Red Hat Single Sign-On。

自动化中心和 Automation 服务目录需要 SSO 和 SSO 管理凭证进行身份验证。

还需要 SSO 管理凭据，以设置应用所需的自动化服务目录特定角色。

如果清单中未提供用于配置的 SSO，则必须使用此变量来定义 SSO 主机。

sso_keystore_file_remote

可选

仅用于 Ansible Automation Platform 管理的 Red Hat Single Sign-On。

如果客户提供的密钥存储位于远程节点上，则设置为 true。

默认为 false

sso_keystore_name

可选

仅用于 Ansible Automation Platform 管理的 Red Hat Single Sign-On。

SSO 的密钥存储名称。

默认 = ansible-automation-platform

sso_keystore_password

启用 HTTPS 的 SSO 的密钥存储密码。

在使用 Ansible Automation Platform 管理的 SSO 以及启用 HTTPS 时，需要此项。默认安装使用 sso_use_https=true 部署 SSO。

sso_redirect_host

可选

用于 Ansible Automation Platform 管理的和外部管理的 Red Hat Single Sign-On。

如果设置了 sso_redirect_host，应用程序会使用它来连接到 SSO 以进行身份验证。

这必须可从客户端机器访问。

sso_ssl_validate_certs

可选

用于 Ansible Automation Platform 管理的和外部管理的 Red Hat Single Sign-On。

如果要在连接过程中验证证书，设置为 true。

默认为 true

sso_use_https

可选

用于 Ansible Automation Platform 管理的和外部管理的 Red Hat Single Sign-On。

如果单点登录使用 https。

默认为 true

automationcatalog_controller_password

用于从控制器主机生成令牌。

还需要定义 automation_controller_main_url。

automationcatalog_controller_token

用于为自动化控制器创建预创建的 OAuth 令牌。此令牌将被使用，而不是生成令牌。

automationcatalog_controller_username

用于从控制器主机生成令牌。还需要定义 automation_controller_main_url。

automationcatalog_controller_verify_ssl

用于启用或禁用自动化服务目录到自动化控制器的 SSL 验证。

默认为 true。

automationcatalog_disable_hsts

用于启用或禁用自动服务目录的 HSTS web-security 策略。

默认 = 'false.

automationcatalog_disable_https

用于启用或禁用 Services Catalog 的 HSTS web-security 策略。

默认为 false。

automationcatalog_enable_analytics_collection

用于控制自动服务目录的分析集合激活

automationcatalog_main_url

如果需要在 SSO 和自动服务目录主机之间进行使用的替代主机名，则由红帽单点登录主机配置使用。

automationcatalog_pg_database

自动服务目录的 postgres 数据库 URL。

automationcatalog_pg_host

用于自动化服务目录的 PostgreSQL 主机（数据库节点）

automationcatalog_pg_password

自动服务目录的 PostgreSQL 数据库的密码。

对于 automationcatalog_pg_password，不要使用特殊字符。它们可能会导致密码失败。

automationcatalog_pg_port

用于自动化服务目录的 PostgreSQL 端口。

默认 = 5432

automationcatalog_pg_username

自动服务目录的 postgres ID。

automationcatalog_ssl_cert

自定义提供的 SSL 证书文件的路径。需要 Automationcatalog_ssl_key。使用内部管理的 CA 进行签名，如果未提供证书并且启用了 https，则创建证书。

automationcatalog_ssl_key

自定义提供的 SSL 证书密钥文件的路径。

需要 automationcatalog_ssl_cert。

内部管理的 CA 签署，并在为提供且启用了 https 的情况下创建证书。

admin_password

安装完成时访问 UI 的管理用户的密码。

automation_controller_main_url

对于 SSO 配置自动化服务目录所需的替代前端 URL，请提供 URL。

自动化服务目录需要控制器安装，或者一个指向活跃和可路由的 Controller 服务器的 URL 则必须提供此变量

automationcontroller_password

自动化控制器实例的密码。

automationcontroller_username

自动化控制器实例的用户名。

nginx_http_port

nginx HTTP 服务器侦听入站连接。

默认为 80

nginx_https_port

nginx HTTPS 服务器侦听安全连接。

默认为 443

nginx_hsts_max_age

此变量指定系统应被视为 HTTP Strict Transport Security (HSTS)主机的时间（以秒为单位）。也就是 HTTPS 专用于通信的时间。

默认为 63072000 秒，或两年。

nginx_tls_protocols

定义 Nginx 中对 ssl_protocols 的支持。

默认为 TLSv1.2。

node_state

可选

节点或一组节点的状态。有效选项为 active, deprovision 从集群中删除节点，或 iso_migrate 将旧的隔离节点迁移到执行节点。

默认为 active。

node_type

对于 [automationcontroller] 组。

可以为这个组分配两个有效的 node_types。

node_type=control 意味着节点只运行项目和清单更新，但不运行常规作业。

node_type=hybrid 能够运行所有内容。

这个组的默认为 hybrid。

对于 [execution_nodes] 组

可以为这个组分配两个有效的 node_types。

node_type=hop 表示节点将作业转发到执行节点。

node_type=execution 表示节点可以运行作业。

此组的默认值为 execution。

peers

可选

peers 变量用于指示特定主机或组连接到哪些节点。一旦定义了 peers 变量，则将建立出站连接到特定主机或组。

此变量用于在 receptor.conf 文件中添加用于与其他节点建立网络连接的 tcp-peer 条目。请参阅 Peering

peers 变量可以是清单中以逗号分隔的主机和/或组的列表。这被解析为用来构造 receptor.conf 文件的一组主机。

pg_database

postgres 数据库的名称。

默认为 awx。

pg_host

postgreSQL 主机，可以是外部管理的数据库。

pg_password

postgreSQL 数据库的密码。

对于 forpg_password，不要使用特殊字符。它们可能会导致密码失败。

注意

安装时，您将不再需要在清单文件中提供 apg_hashed_password，因为 PostgreSQL 13 现在可以更加安全地存储用户的密码。

当您在清单文件中为安装程序提供 pg_password 时，PostgreSQL 使用 SCRAM-SHA-256 哈希在安装过程中保护该密码。

pg_port

要使用的 postgreSQL 端口。

默认 = 5432

pg_ssl_mode

prefer 或 verify-full 之一。

设置为 verify-full，用于客户端强制执行 SSL。

默认为 prefer。

pg_username

您的 postgres 数据库用户名。

默认为 awx。

postgres_ssl_cert

postgres ssl 证书的位置。

/path/to/pgsql_ssl.cert

postgres_ssl_key

postgres ssl 键的位置。

/path/to/pgsql_ssl.key

postgres_use_cert

postgres 用户证书的位置。

/path/to/pgsql.crt

postgres_use_key

postgres 用户密钥的位置。

/path/to/pgsql.key

postgres_use_ssl

postgres 是否使用 SSL。

receptor_listener_port

用于 recptor 连接的端口。

默认 = 27199。

supervisor_start_retry_count

当指定时（不存在默认值），将 startretries = <value specified> 添加到 supervisor 配置文件 (/etc/supervisord.d/tower.ini) 中。

有关 startretries 的进一步说明，请参阅 program:x section 值。

web_server_ssl_cert

可选

/path/to/webserver.cert

与 automationhub_ssl_cert 相同，但用于 Web 服务器 UI 和 API。

web_server_ssl_key

可选

/path/to/webserver.key

与 automationhub_server_ssl_key 相同，但用于 Web 服务器 UI 和 API。

ansible_connection

用于目标主机上任务的连接插件。

这可以是任何 ansible 连接插件的名称。SSH 协议类型是 smart、ssh 或 paramiko。

默认为 smart

ansible_host

要使用的目标主机的 ip 或名称，而不是 inventory_hostname。

ansible_port

连接端口号（如果没有提供，默认为 22 用于 ssh）。

ansible_user

连接到主机时使用的用户名。

ansible_password

用于向主机进行身份验证的密码。

从不以纯文本形式存储此变量。

始终使用密码库。

ansible_ssh_private_key_file

ssh 使用的私钥文件。在使用多个密钥且您不想使用 SSH 代理时很有用。

ansible_ssh_common_args

此设置始终附加到 sftp、scp 和 ssh 的默认命令行中。对于为特定主机（或组）配置 ProxyCommand 很有用。

ansible_sftp_extra_args

此设置始终附加到默认的 sftp 命令行。

ansible_scp_extra_args

此设置始终附加到默认的 scp 命令行。

ansible_ssh_extra_args

此设置始终附加到默认的 ssh 命令行。

ansible_ssh_pipelining

确定是否使用 SSH pipelining。这可以覆盖 ansible.cfg 中的 pipelining 设置。如果使用基于 SSH 密钥的身份验证，则密钥必须由 SSH 代理管理。

ansible_ssh_executable

（在 2.2 版中添加）

此设置覆盖使用系统 ssh 的默认行为。这可以覆盖 ansible.cfg 中的 ssh_executable 设置。

ansible_shell_type

目标系统的 shell 类型。除非将 ansible_shell_executable 设置为一个非兼容 shell，否则不应使用此设置。默认情况下，使用 sh 样式的语法对命令进行了格式化。把它设置为 csh 或 fish 会导致在目标系统上执行命令来遵循这些 shell 的语法。

ansible_shell_executable

这会设置 ansible 控制器在目标机器上使用的 shell，并覆盖 ansible.cfg 中的可执行文件，默认为 /bin/sh。

只有在无法使用 /bin/sh 时（也就是说，如果目标机器上没有安装 /bin/sh ）或者无法从 sudo 运行，才应更改。

inventory_hostname

此变量从清单脚本或 ansible 配置文件获取机器的主机名。

您不能设置此变量的值。

由于从配置文件中获取了该值，实际运行时主机名值可能与此变量返回的不同。