Skip to content

Commit 7647463

Browse files
authored
Added descriptions for ca_tls_* variables (#2360)
Also reordered the list to be alphabetical [Docs] Update description of CA variables in Containerized installer documentation https://issues.redhat.com/browse/AAP-33585
1 parent 6cb51e4 commit 7647463

File tree

1 file changed

+39
-35
lines changed

1 file changed

+39
-35
lines changed

downstream/modules/platform/ref-general-inventory-variables.adoc

Lines changed: 39 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,31 @@
55
[cols="50%,50%,50%",options="header"]
66
|====
77
| *RPM variable name* | *Container variable name* | *Description*
8+
| |`bundle_dir` |The path to the bundle directory.
9+
10+
Default = `false`
11+
| |`bundle_install` |Use offline installation. Set to `true` to enable offline installation.
12+
13+
Default = `false`
14+
15+
| |`ca_tls_cert` | Define a Certification Authority certificate here along with a matching key in `ca_tls_key` when you want the installer to create leaf certificates for each product for you.
16+
17+
| |`ca_tls_key` | Define the key for a Certication Authority certificate here for the matching certificate in `ca_tls_cert` when you want the installer to create leaf certs for each product for you.
18+
19+
| |`ca_tls_remote` |TLS CA remote files.
20+
21+
Default = `false`
22+
| |`container_compress` |Container compression software.
23+
24+
Default = `gzip`
25+
| |`container_keep_images` |Keep container images.
26+
27+
Default = `false`
28+
| |`container_pull_images` |Pull newer container images.
29+
30+
Default = `true`
31+
| |`custom_ca_cert` | Define a custom Certification Authority certificate here when you have the leaf certificates created for each product and need the certificate trust to be established.
32+
833
| `enable_insights_collection` | | The default install registers the node to the {InsightsName} for the {PlatformName} Service if the node is registered with Subscription Manager.
934

1035
Set to `False` to disable.
@@ -26,6 +51,16 @@ Default = `TLSv1.2`
2651
Each element in the list is provided into `http nginx config` as a separate line.
2752

2853
Default = empty list
54+
| |`registry_auth` |Use registry authentication.
55+
56+
Default = `true`
57+
58+
| |`registry_ns_aap` |{PlatformNameShort} registry namespace.
59+
60+
Default = `ansible-automation-platform-25`
61+
| |`registry_ns_rhel` |RHEL registry namespace.
62+
63+
Default = `rhel8`
2964
| `registry_password` |`registry_password` | This variable is only required if a non-bundle installer is used.
3065

3166
Password credential for access to `registry_url`.
@@ -35,6 +70,10 @@ Enter your Red Hat Registry Service Account credentials in `registry_username` a
3570
When `registry_url` is `registry.redhat.io`, username and password are required if not using a bundle installer.
3671

3772
For more information, see link:{URLInstallationGuide}/assembly-platform-install-scenario#proc-set-registry-username-password[Setting registry_username and registry_password].
73+
| |`registry_tls_verify` |Verify registry TLS.
74+
75+
Default = `true`
76+
3877
| `registry_url` |`registry_url` | URL for the registry source.
3978

4079
Default = `registry.redhat.io`
@@ -52,41 +91,6 @@ If `routable_hostname` is not set, it should default to `ansible_host`. If you d
5291
This variable is used as a host variable for particular hosts and not under the `[all:vars]` section.
5392

5493
For further information, see link:https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#assigning-a-variable-to-one-machine-host-variables[Assigning a variable to one machine: host variables].
55-
| |`bundle_dir` |The path to the bundle directory.
56-
57-
Default = `false`
58-
| |`bundle_install` |Use offline installation. Set to `true` to enable offline installation.
59-
60-
Default = `false`
61-
62-
| |`ca_tls_cert` |TLS CA certificate.
63-
| |`ca_tls_key` | TLS CA key.
64-
| |`ca_tls_remote` |TLS CA remote files.
65-
66-
Default = `false`
67-
| |`container_compress` |Container compression software.
68-
69-
Default = `gzip`
70-
| |`container_keep_images` |Keep container images.
71-
72-
Default = `false`
73-
| |`container_pull_images` |Pull newer container images.
74-
75-
Default = `true`
76-
| |`custom_ca_cert` |Custom TLS CA certificate.
77-
| |`registry_auth` |Use registry authentication.
78-
79-
Default = `true`
80-
| |`registry_ns_aap` |{PlatformNameShort} registry namespace.
81-
82-
Default = `ansible-automation-platform-25`
83-
| |`registry_ns_rhel` |RHEL registry namespace.
84-
85-
Default = `rhel8`
86-
| |`registry_tls_verify` |Verify registry TLS.
87-
88-
Default = `true`
89-
9094
|====
9195

9296

0 commit comments

Comments
 (0)