Skip to content

Commit cc24338

Browse files
michellemacrhmichellemacrh
authored
Update inventory file examples (#2683)
Update the inventory file examples to match what's included when downloading the installers Affects titles: - `aap-containerized-install` - `topologies` Update the installer inventory files to match the ones supplied to the user https://issues.redhat.com/browse/AAP-37239
1 parent 0e66187 commit cc24338

File tree

7 files changed

+74
-59
lines changed

7 files changed

+74
-59
lines changed

‎downstream/modules/platform/proc-installing-containerized-aap.adoc

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,14 @@ Use the example inventory file to perform an online installation for the contain
2626

2727
[source,yaml,subs="+attributes"]
2828
----
29-
# This is the {PlatformNameShort} growth installer inventory file
30-
# Please consult the docs if you are unsure what to add
31-
# For all optional variables please consult the included README.md
32-
# or the Red Hat documentation:
29+
# This is the {PlatformNameShort} installer inventory file intended for the container growth deployment topology.
30+
# This inventory file expects to be run from the host where {PlatformNameShort} will be installed.
31+
# Consult the {PlatformNameShort} product documentation about this topology's tested hardware configuration.
32+
# {URLTopologies}/container-topologies
33+
#
34+
# Consult the docs if you are unsure what to add
35+
# For all optional variables consult the included README.md
36+
# or the {PlatformNameShort} documentation:
3337
# {URLContainerizedInstall}
3438
3539
# This section is for your {Gateway} hosts
@@ -72,7 +76,7 @@ registry_password=<your RHN password>
7276
7377
redis_mode=standalone
7478
75-
# Platform gateway
79+
# {GatewayStart}
7680
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-gateway-variables
7781
# -----------------------------------------------------
7882
gateway_admin_password=<set your own>
@@ -108,8 +112,8 @@ Use the example inventory file to perform an online installation for the contain
108112
[source,yaml,subs="+attributes"]
109113
----
110114
# This is the {PlatformNameShort} enterprise installer inventory file
111-
# Please consult the docs if you are unsure what to add
112-
# For all optional variables please consult the included README.md
115+
# Consult the docs if you are unsure what to add
116+
# For all optional variables consult the included README.md
113117
# or the Red Hat documentation:
114118
# {URLContainerizedInstall}
115119
@@ -162,7 +166,7 @@ postgresql_admin_password=<set your own>
162166
registry_username=<your RHN username>
163167
registry_password=<your RHN password>
164168
165-
# Platform gateway
169+
# {GatewayStart}
166170
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-gateway-variables
167171
# -----------------------------------------------------
168172
gateway_admin_password=<set your own>

‎downstream/modules/topologies/ref-cont-a-env-a.adoc

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,15 @@ Use the example inventory file to perform an installation for this topology:
7373

7474
[source,yaml,subs="+attributes"]
7575
----
76-
# This is the growth installer inventory file
77-
# Please consult the docs if you are unsure what to add
78-
# For all optional variables please consult the included README.md
79-
# or the Red Hat documentation:
80-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation
76+
# This is the {PlatformNameShort} installer inventory file intended for the container growth deployment topology.
77+
# This inventory file expects to be run from the host where {PlatformNameShort} will be installed.
78+
# Consult the {PlatformNameShort} product documentation about this topology's tested hardware configuration.
79+
# {URLTopologies}/container-topologies
80+
#
81+
# Consult the docs if you are unsure what to add
82+
# For all optional variables consult the included README.md
83+
# or the {PlatformNameShort} documentation:
84+
# {URLContainerizedInstall}
8185
8286
# This section is for your {Gateway} hosts
8387
# -----------------------------------------------------
@@ -109,7 +113,7 @@ aap.example.org
109113
ansible_connection=local
110114
111115
# Common variables
112-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#ref-general-inventory-variables
116+
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-general-inventory-variables
113117
# -----------------------------------------------------
114118
postgresql_admin_username=postgres
115119
postgresql_admin_password=<set your own>
@@ -120,28 +124,28 @@ registry_password=<your RHN password>
120124
redis_mode=standalone
121125
122126
# {GatewayStart}
123-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#ref-gateway-variables
127+
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-gateway-variables
124128
# -----------------------------------------------------
125129
gateway_admin_password=<set your own>
126130
gateway_pg_host=aap.example.org
127131
gateway_pg_password=<set your own>
128132
129133
# {ControllerNameStart}
130-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#ref-controller-variables
134+
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-controller-variables
131135
# -----------------------------------------------------
132136
controller_admin_password=<set your own>
133137
controller_pg_host=aap.example.org
134138
controller_pg_password=<set your own>
135139
136140
# {HubNameStart}
137-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#ref-hub-variables
141+
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-hub-variables
138142
# -----------------------------------------------------
139143
hub_admin_password=<set your own>
140144
hub_pg_host=aap.example.org
141145
hub_pg_password=<set your own>
142146
143147
# {EDAcontroller}
144-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#event-driven-ansible-controller
148+
# {URLContainerizedInstall}/appendix-inventory-files-vars#event-driven-ansible-controller
145149
# -----------------------------------------------------
146150
eda_admin_password=<set your own>
147151
eda_pg_host=aap.example.org

‎downstream/modules/topologies/ref-cont-b-env-a.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,11 @@ Use the example inventory file to perform an installation for this topology:
8282

8383
[source,yaml,subs="+attributes"]
8484
----
85-
# This is the enterprise installer inventory file
86-
# Please consult the docs if you are unsure what to add
87-
# For all optional variables please consult the included README.md
85+
# This is the {PlatformNameShort} enterprise installer inventory file
86+
# Consult the docs if you are unsure what to add
87+
# For all optional variables consult the included README.md
8888
# or the Red Hat documentation:
89-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation
89+
# {URLContainerizedInstall}
9090
9191
# This section is for your {Gateway} hosts
9292
# -----------------------------------------------------
@@ -130,15 +130,15 @@ eda2.example.org
130130
[all:vars]
131131
132132
# Common variables
133-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#ref-general-inventory-variables
133+
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-general-inventory-variables
134134
# -----------------------------------------------------
135135
postgresql_admin_username=<set your own>
136136
postgresql_admin_password=<set your own>
137137
registry_username=<your RHN username>
138138
registry_password=<your RHN password>
139139
140140
# {GatewayStart}
141-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#ref-gateway-variables
141+
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-gateway-variables
142142
# -----------------------------------------------------
143143
gateway_admin_password=<set your own>
144144
gateway_pg_host=externaldb.example.org
@@ -147,7 +147,7 @@ gateway_pg_username=<set your own>
147147
gateway_pg_password=<set your own>
148148
149149
# {ControllerNameStart}
150-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#ref-controller-variables
150+
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-controller-variables
151151
# -----------------------------------------------------
152152
controller_admin_password=<set your own>
153153
controller_pg_host=externaldb.example.org
@@ -156,7 +156,7 @@ controller_pg_username=<set your own>
156156
controller_pg_password=<set your own>
157157
158158
# {HubNameStart}
159-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#ref-hub-variables
159+
# {URLContainerizedInstall}/appendix-inventory-files-vars#ref-hub-variables
160160
# -----------------------------------------------------
161161
hub_admin_password=<set your own>
162162
hub_pg_host=externaldb.example.org
@@ -165,7 +165,7 @@ hub_pg_username=<set your own>
165165
hub_pg_password=<set your own>
166166
167167
# {EDAcontroller}
168-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars#event-driven-ansible-controller
168+
# {URLContainerizedInstall}/appendix-inventory-files-vars#event-driven-ansible-controller
169169
# -----------------------------------------------------
170170
eda_admin_password=<set your own>
171171
eda_pg_host=externaldb.example.org

‎downstream/modules/topologies/ref-rpm-a-env-a.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,14 @@ Use the example inventory file to perform an installation for this topology:
6868

6969
[source,yaml,subs="+attributes"]
7070
----
71-
# This is the growth installer inventory file
72-
# Please consult the docs if you are unsure what to add
73-
# For all optional variables please consult the Red Hat documentation:
74-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation
71+
# This is the {PlatformNameShort} installer inventory file intended for the RPM growth deployment topology.
72+
# Consult the {PlatformNameShort} product documentation about this topology's tested hardware configuration.
73+
# {URLTopologies}/rpm-topologies
74+
#
75+
# Consult the docs if you are unsure what to add
76+
# For all optional variables consult the {PlatformNameShort} documentation:
77+
# {URLInstallationGuide}
78+
7579
7680
# This section is for your {Gateway} hosts
7781
# -----------------------------------------------------
@@ -109,36 +113,36 @@ db.example.org
109113
[all:vars]
110114
111115
# Common variables
112-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-general-inventory-variables
116+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-general-inventory-variables
113117
# -----------------------------------------------------
114118
registry_username=<your RHN username>
115119
registry_password=<your RHN password>
116120
117121
redis_mode=standalone
118122
119123
# {GatewayStart}
120-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-gateway-variables
124+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-gateway-variables
121125
# -----------------------------------------------------
122126
automationgateway_admin_password=<set your own>
123127
automationgateway_pg_host=db.example.org
124128
automationgateway_pg_password=<set your own>
125129
126130
# {ControllerNameStart}
127-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-controller-variables
131+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-controller-variables
128132
# -----------------------------------------------------
129133
admin_password=<set your own>
130134
pg_host=db.example.org
131135
pg_password=<set your own>
132136
133137
# {HubNameStart}
134-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-hub-variables
138+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-hub-variables
135139
# -----------------------------------------------------
136140
automationhub_admin_password=<set your own>
137141
automationhub_pg_host=db.example.org
138142
automationhub_pg_password=<set your own>
139143
140144
# {EDAcontroller}
141-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#event-driven-ansible-controller
145+
# {URLInstallationGuide}/appendix-inventory-files-vars#event-driven-ansible-controller
142146
# -----------------------------------------------------
143147
automationedacontroller_admin_password=<set your own>
144148
automationedacontroller_pg_host=db.example.org

‎downstream/modules/topologies/ref-rpm-a-env-b.adoc

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,13 @@ Use the example inventory file to perform an installation for this topology:
6969

7070
[source,yaml,subs="+attributes"]
7171
----
72-
# This is the mixed growth installer inventory file
73-
# Please consult the docs if you are unsure what to add
74-
# For all optional variables please consult the Red Hat documentation:
75-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation
72+
# This is the {PlatformNameShort} installer inventory file intended for the mixed RPM growth deployment topology.
73+
# Consult the {PlatformNameShort} product documentation about this topology's tested hardware configuration.
74+
# {URLTopologies}/rpm-topologies
75+
#
76+
# Consult the docs if you are unsure what to add
77+
# For all optional variables consult the Red Hat documentation:
78+
# {URLInstallationGuide}
7679
7780
# This section is for your {Gateway} hosts
7881
# -----------------------------------------------------
@@ -87,22 +90,22 @@ eda.example.org
8790
[all:vars]
8891
8992
# Common variables
90-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-general-inventory-variables
93+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-general-inventory-variables
9194
# -----------------------------------------------------
9295
registry_username=<your RHN username>
9396
registry_password=<your RHN password>
9497
9598
redis_mode=standalone
9699
97100
# {GatewayStart}
98-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-gateway-variables
101+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-gateway-variables
99102
# -----------------------------------------------------
100103
automationgateway_admin_password=<set your own>
101104
automationgateway_pg_host=db.example.org
102105
automationgateway_pg_password=<set your own>
103106
104107
# {EDAcontroller}
105-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#event-driven-ansible-controller
108+
# {URLInstallationGuide}/appendix-inventory-files-vars#event-driven-ansible-controller
106109
# -----------------------------------------------------
107110
automationedacontroller_admin_password=<set your own>
108111
automationedacontroller_pg_host=db.example.org

‎downstream/modules/topologies/ref-rpm-b-env-a.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ Use the example inventory file to perform an installation for this topology:
7878

7979
[source,yaml,subs="+attributes"]
8080
----
81-
# This is the enterprise installer inventory file
82-
# Please consult the docs if you are unsure what to add
83-
# For all optional variables please consult the Red Hat documentation:
84-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation
81+
# This is the {PlatformNameShort} enterprise installer inventory file
82+
# Consult the docs if you are unsure what to add
83+
# For all optional variables consult the Red Hat documentation:
84+
# {URLInstallationGuide}
8585
8686
# This section is for your {Gateway} hosts
8787
# -----------------------------------------------------
@@ -127,13 +127,13 @@ eda2.example.org
127127
128128
[all:vars]
129129
# Common variables
130-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-general-inventory-variables
130+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-general-inventory-variables
131131
# -----------------------------------------------------
132132
registry_username=<your RHN username>
133133
registry_password=<your RHN password>
134134
135135
# {GatewayStart}
136-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-gateway-variables
136+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-gateway-variables
137137
# -----------------------------------------------------
138138
automationgateway_admin_password=<set your own>
139139
automationgateway_pg_host=<set your own>
@@ -142,7 +142,7 @@ automationgateway_pg_username=<set your own>
142142
automationgateway_pg_password=<set your own>
143143
144144
# {ControllerNameStart}
145-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-controller-variables
145+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-controller-variables
146146
# -----------------------------------------------------
147147
admin_password=<set your own>
148148
pg_host=<set your own>
@@ -151,7 +151,7 @@ pg_username=<set your own>
151151
pg_password=<set your own>
152152
153153
# {HubNameStart}
154-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-hub-variables
154+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-hub-variables
155155
# -----------------------------------------------------
156156
automationhub_admin_password=<set your own>
157157
automationhub_pg_host=<set your own>
@@ -160,7 +160,7 @@ automationhub_pg_username=<set your own>
160160
automationhub_pg_password=<set your own>
161161
162162
# {EDAcontroller}
163-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#event-driven-ansible-controller
163+
# {URLInstallationGuide}/appendix-inventory-files-vars#event-driven-ansible-controller
164164
# -----------------------------------------------------
165165
automationedacontroller_admin_password=<set your own>
166166
automationedacontroller_pg_host=<set your own>

‎downstream/modules/topologies/ref-rpm-b-env-b.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ Use the example inventory file to perform an installation for this topology:
7878

7979
[source,yaml,subs="+attributes"]
8080
----
81-
# This is the mixed enterprise installer inventory file
82-
# Please consult the docs if you are unsure what to add
83-
# For all optional variables please consult the Red Hat documentation:
84-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation
81+
# This is the {PlatformNameShort} mixed enterprise installer inventory file
82+
# Consult the docs if you are unsure what to add
83+
# For all optional variables consult the Red Hat documentation:
84+
# {URLInstallationGuide}
8585
8686
# This section is for your {Gateway} hosts
8787
# -----------------------------------------------------
@@ -107,13 +107,13 @@ eda3.example.org
107107
108108
[all:vars]
109109
# Common variables
110-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-general-inventory-variables
110+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-general-inventory-variables
111111
# -----------------------------------------------------
112112
registry_username=<your RHN username>
113113
registry_password=<your RHN password>
114114
115115
# {GatewayStart}
116-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#ref-gateway-variables
116+
# {URLInstallationGuide}/appendix-inventory-files-vars#ref-gateway-variables
117117
# -----------------------------------------------------
118118
automationgateway_admin_password=<set your own>
119119
automationgateway_pg_host=<set your own>
@@ -122,7 +122,7 @@ automationgateway_pg_username=<set your own>
122122
automationgateway_pg_password=<set your own>
123123
124124
# {EDAcontroller}
125-
# https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-inventory-files-vars#event-driven-ansible-controller
125+
# {URLInstallationGuide}/appendix-inventory-files-vars#event-driven-ansible-controller
126126
# -----------------------------------------------------
127127
automationedacontroller_admin_password=<set your own>
128128
automationedacontroller_pg_host=<set your own>

0 commit comments

Comments
 (0)