From 2057c539a0f2215cee8d2835da216a7d1aee3195 Mon Sep 17 00:00:00 2001 From: lmodemal Date: Thu, 19 Sep 2024 22:54:53 -0400 Subject: [PATCH] AAP-30807-A2: Add hub container variables --- .../modules/platform/ref-hub-variables.adoc | 56 ++++++++++--------- 1 file changed, 29 insertions(+), 27 deletions(-) diff --git a/downstream/modules/platform/ref-hub-variables.adoc b/downstream/modules/platform/ref-hub-variables.adoc index 122006a4b..f7c6b15f7 100644 --- a/downstream/modules/platform/ref-hub-variables.adoc +++ b/downstream/modules/platform/ref-hub-variables.adoc @@ -2,35 +2,35 @@ = {HubNameMain} variables -[cols="50%,50%",options="header"] +[cols="50%,50%,50%",options="header"] |==== -| *Variable* | *Description* -| *`automationhub_admin_password`* | Required passwords must be enclosed in quotes when they are provided in plain text in the inventory file. +| *Variable* |*Container* | *Description* +| *`automationhub_admin_password`* |`hub_admin_password` |Required passwords must be enclosed in quotes when they are provided in plain text in the inventory file. Use of special characters for `automationhub_admin_password` is limited. The password can include any printable ASCII character except `/`, `”`, or `@`. -| *`automationhub_api_token`* a| This variable can be used to provide the installer with an existing token. +| *`automationhub_api_token`* a| | This variable can be used to provide the installer with an existing token. For example, a regenerated token in Hub UI will invalidate an existing token. Use automationhub_api_token` to use that token in the installer the next time you run the installer. -|*`generate_automationhub_token` | When performing a fresh installation, a new token will automatically be generated by default. If you want the installer to regenerate a new token, set `generate_automationhub_token=true` and the installer will use it in the installation process. +|*`generate_automationhub_token`* | |When performing a fresh installation, a new token will automatically be generated by default. If you want the installer to regenerate a new token, set `generate_automationhub_token=true` and the installer will use it in the installation process. -| *`automationhub_auto_sign_collections`* | If a collection signing service is enabled, collections are not signed automatically by default. +| *`automationhub_auto_sign_collections`* |`hub_collection_auto-sign` | If a collection signing service is enabled, collections are not signed automatically by default. Setting this parameter to `true` signs them by default. -Default = `false`. -| *`automationhub_backup_collections`* | _Optional_ +Default = `false` +| *`automationhub_backup_collections`* | |_Optional_ {HubNameMain} provides artifacts in `/var/lib/pulp`. {ControllerNameStart} automatically backs up the artifacts by default. You can also set `automationhub_backup_collections` to false and the backup/restore process does not then backup or restore `/var/lib/pulp`. Default = `true`. -| *`automationhub_collection_download_count`* | _Optional_ +| *`automationhub_collection_download_count`* | | _Optional_ Determines whether download count is displayed on the UI. -Default = `false`. -| *`automationhub_collection_seed_repository`* a| When you run the bundle installer, validated content is uploaded to the `validated` repository, and certified content is uploaded to the `rh-certified` repository. +Default = `false` +| *`automationhub_collection_seed_repository`* a| | When you run the bundle installer, validated content is uploaded to the `validated` repository, and certified content is uploaded to the `rh-certified` repository. By default, both certified and validated content are uploaded. @@ -39,49 +39,49 @@ Possible values of this variable are 'certified' or 'validated'. If you do not want to install content, set `automationhub_seed_collections` to `false` to disable the seeding. If you only want one type of content, set `automationhub_seed_collections` to `true` and `automationhub_collection_seed_repository` to the type of content you do want to include. -| *`automationhub_collection_signing_service_key`* | If a collection signing service is enabled, you must provide this variable to ensure that collections can be properly signed. +| *`automationhub_collection_signing_service_key`* |`hub-collection-signing_key` | If a collection signing service is enabled, you must provide this variable to ensure that collections can be properly signed. `/absolute/path/to/key/to/sign` -| *`automationhub_collection_signing_service_script`* | If a collection signing service is enabled, you must provide this variable to ensure that collections can be properly signed. +| *`automationhub_collection_signing_service_script`* | | If a collection signing service is enabled, you must provide this variable to ensure that collections can be properly signed. `/absolute/path/to/script/that/signs` -| *`automationhub_create_default_collection_signing_service`* | Set this variable to true to create a collection signing service. +| *`automationhub_create_default_collection_signing_service`* |`hub_container_signing_service` |Set this variable to true to create a collection signing service. Default = `false`. -| *`automationhub_container_signing_service_key`* | If a container signing service is enabled, you must provide this variable to ensure that containers can be properly signed. +| *`automationhub_container_signing_service_key`* |`hub-container_signing_key` |If a container signing service is enabled, you must provide this variable to ensure that containers can be properly signed. `/absolute/path/to/key/to/sign` -| *`automationhub_container_signing_service_script`* | If a container signing service is enabled, you must provide this variable to ensure that containers can be properly signed. +| *`automationhub_container_signing_service_script`* | |If a container signing service is enabled, you must provide this variable to ensure that containers can be properly signed. `/absolute/path/to/script/that/signs` -| *`automationhub_create_default_container_signing_service`* | Set this variable to true to create a container signing service. +| *`automationhub_create_default_container_signing_service`* | | Set this variable to true to create a container signing service. Default = `false`. -| *`automationhub_disable_hsts`* | The default installation deploys a TLS enabled {HubNameMain}. +| *`automationhub_disable_hsts`* |`automation_nginx_disable_hsts` | The default installation deploys a TLS enabled {HubNameMain}. Use this variable if you deploy {HubName} with _HTTP Strict Transport Security_ (HSTS) web-security policy enabled. This variable disables the HSTS web-security policy mechanism. Default = `false`. -| *`automationhub_disable_https`* | _Optional_ +| *`automationhub_disable_https`* |`hub_nginx_disable_https` |_Optional_ If {HubNameMain} is deployed with HTTPS enabled. Default = `false`. -| *`automationhub_enable_api_access_log`* | When set to `true`, this variable creates a log file at `/var/log/galaxy_api_access.log` that logs all user actions made to the platform, including their username and IP address. +| *`automationhub_enable_api_access_log`* | | When set to `true`, this variable creates a log file at `/var/log/galaxy_api_access.log` that logs all user actions made to the platform, including their username and IP address. Default = `false`. -| *`automationhub_enable_analytics`* | A Boolean indicating whether to enable pulp analytics for the version of pulpcore used in {HubName} in {PlatformNameShort} {PlatformVers}. +| *`automationhub_enable_analytics`* | |A Boolean indicating whether to enable pulp analytics for the version of pulpcore used in {HubName} in {PlatformNameShort} {PlatformVers}. To enable pulp analytics, set `automationhub_enable_analytics` to true. Default = `false`. -| *`automationhub_enable_unauthenticated_collection_access`* | Set this variable to true to enable unauthorized users to view collections. +| *`automationhub_enable_unauthenticated_collection_access`* | | Set this variable to true to enable unauthorized users to view collections. Default = `false`. -| *`automationhub_enable_unauthenticated_collection_download`* | Set this variable to true to enable unauthorized users to download collections. +| *`automationhub_enable_unauthenticated_collection_download`* | |Set this variable to true to enable unauthorized users to download collections. Default = `false`. -| *`automationhub_importer_settings`* | _Optional_ +| *`automationhub_importer_settings`* |`hub_galaxy_importer` |_Optional_ Dictionary of setting to pass to galaxy-importer. @@ -92,11 +92,13 @@ Behavior is driven by `galaxy-importer.cfg` configuration. Examples are `ansible-doc`, `ansible-lint`, and `flake8`. This parameter enables you to drive this configuration. -| *`automationhub_pg_database`* | _Required_ +| *`automationhub_pg_database`* |`hub_pg_database` |_Optional_ -The database name. +The PostgreSQL database name. -Default = `automationhub`. +RPM default = `automationhub` + +Container default = pulp | *`automationhub_pg_host`* | Required if not using an internal database. The hostname of the remote PostgreSQL database used by {HubName}.