Skip to content

Commit d03abea

Browse files
adellapeadellape
authored
Merge pull request #7274 from mtnbikenc/byo-refactor
Update 'byo' references based on playbook refactoring
2 parents 3833160 + ad443a0 commit d03abea

7 files changed

+50
-41
lines changed

‎admin_solutions/master_node_config.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ xref:../admin_solutions/master_node_config.adoc#master-node-config-manual[manual
6969
For this section, familiarity with Ansible is assumed.
7070

7171
Only a portion of the available host configuration options are
72-
https://github.com/openshift/openshift-ansible/blob/master/inventory/byo/hosts.ose.example[exposed to Ansible].
72+
https://github.com/openshift/openshift-ansible/blob/master/inventory/hosts.example[exposed to Ansible].
7373
After an {product-title} install, Ansible creates an
7474
inventory file with some substituted values. Modifying this inventory file and re-running the Ansible installer playbook is how you customize your {product-title} cluster.
7575

@@ -145,15 +145,15 @@ openshift_master_htpasswd_users={'jsmith': '$apr1$wIwXkFLI$bAygtKGmPOqaJftB', 'b
145145
. Re-run the ansible playbook for these modifications to take effect:
146146
+
147147
----
148-
$ ansible-playbook -b -i ./hosts ~/src/openshift-ansible/playbooks/byo/config.yml
148+
$ ansible-playbook -b -i ./hosts ~/src/openshift-ansible/playbooks/deploy_cluster.yml
149149
----
150150
+
151151
The playbook updates the configuration, and restarts the {product-title} master service to apply the changes.
152152

153153
You have now modified the master and node configuration files using Ansible, but this is just a simple use case. From here you can see which
154154
xref:../admin_solutions/master_node_config.adoc#master-config-options[master] and
155155
xref:../admin_solutions/master_node_config.adoc#node-config-options[node configuration] options are
156-
https://github.com/openshift/openshift-ansible/blob/master/inventory/byo/hosts.ose.example[exposed to Ansible] and customize your own Ansible inventory.
156+
https://github.com/openshift/openshift-ansible/blob/master/inventory/hosts.example[exposed to Ansible] and customize your own Ansible inventory.
157157

158158
[[htpasswd]]
159159
==== Using the `htpasswd` commmand
@@ -398,7 +398,7 @@ a|Controls limits and behavior for importing images:
398398
- `*ScheduledImageImportMinimumIntervalSeconds*` (integer): The minimum number of seconds that can elapse between when image streams scheduled for background import are checked against the upstream repository. The default value is `900` (15 minutes).
399399
- `*MaxScheduledImageImportsPerMinute*` (integer): The maximum number of image streams that can be imported in the background, per minute. The default value is `60`. This can be set to `-1` for unlimited imports.
400400

401-
https://github.com/openshift/openshift-ansible/blob/master/inventory/byo/hosts.ose.example[This can be controlled with the Ansible inventory].
401+
https://github.com/openshift/openshift-ansible/blob/master/inventory/hosts.example[This can be controlled with the Ansible inventory].
402402

403403
|`*kubernetesMasterConfig*`
404404
|Contains information about how to connect to kubelet's KubernetesMasterConfig. If present, then start the kubernetes master with this process.

‎install_config/cluster_metrics.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,7 @@ openshift_prometheus_node_selector={"region":"infra"}
862862

863863
Run the playbook:
864864
----
865-
$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/byo/openshift-cluster/openshift-prometheus.yml
865+
$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/openshift-prometheus/config.yml
866866
----
867867

868868
[[openshift-prometheus-additional-deploy]]
@@ -886,7 +886,7 @@ openshift_prometheus_node_selector={"${KEY}":"${VALUE}"}
886886

887887
Run the playbook:
888888
----
889-
$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/byo/openshift-cluster/openshift-prometheus.yml
889+
$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/openshift-prometheus/config.yml
890890
----
891891

892892
*Deploy Using a Non-default Namespace*
@@ -902,7 +902,7 @@ openshift_prometheus_namespace=${USER_PROJECT}
902902

903903
Run the playbook:
904904
----
905-
$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/byo/openshift-cluster/openshift-prometheus.yml
905+
$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/openshift-prometheus/config.yml
906906
----
907907

908908
[[openshift-prometheus-web]]
@@ -1037,5 +1037,5 @@ gathered from the `http://${POD_IP}:7575/metrics` endpoint.
10371037
To undeploy Prometheus, run:
10381038

10391039
----
1040-
$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/byo/openshift-cluster/openshift-prometheus.yml -e openshift_prometheus_state=absent
1040+
$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/openshift-prometheus/config.yml -e openshift_prometheus_state=absent
10411041
----

‎install_config/install/advanced_install.adoc

+25-22
Original file line numberDiff line numberDiff line change
@@ -2361,11 +2361,11 @@ other than *_/etc/ansible/hosts_*:
23612361
----
23622362
ifdef::openshift-enterprise[]
23632363
# ansible-playbook [-i /path/to/inventory] \
2364-
/usr/share/ansible/openshift-ansible/playbooks/byo/config.yml
2364+
/usr/share/ansible/openshift-ansible/playbooks/deploy_cluster.yml
23652365
endif::[]
23662366
ifdef::openshift-origin[]
23672367
# ansible-playbook [-i /path/to/inventory] \
2368-
~/openshift-ansible/playbooks/byo/config.yml
2368+
~/openshift-ansible/playbooks/deploy_cluster.yml
23692369
endif::[]
23702370
----
23712371

@@ -2431,7 +2431,7 @@ or workarounds.
24312431

24322432
You can use the `PLAYBOOK_FILE` environment variable to specify other playbooks
24332433
you want to run by using the containerized installer. The default value of the `PLAYBOOK_FILE` is
2434-
*_/usr/share/ansible/openshift-ansible/playbooks/byo/config.yml_*, which is the
2434+
*_/usr/share/ansible/openshift-ansible/playbooks/deploy_cluster.yml_*, which is the
24352435
main cluster installation playbook, but you can set it to the path of another
24362436
playbook inside the container.
24372437

@@ -2443,7 +2443,7 @@ installation, use the following command:
24432443
# atomic install --system \
24442444
--storage=ostree \
24452445
--set INVENTORY_FILE=/path/to/inventory \
2446-
--set PLAYBOOK_FILE=/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-checks/pre-install.yml \ <1>
2446+
--set PLAYBOOK_FILE=/usr/share/ansible/openshift-ansible/playbooks/openshift-checks/pre-install.yml \ <1>
24472447
--set OPTS="-v" \ <2>
24482448
ifdef::openshift-enterprise[]
24492449
registry.access.redhat.com/openshift3/ose-ansible:v3.7
@@ -2488,7 +2488,7 @@ $ docker run -t -u `id -u` \ <1>
24882488
-v $HOME/.ssh/id_rsa:/opt/app-root/src/.ssh/id_rsa:Z \ <2>
24892489
-v $HOME/ansible/hosts:/tmp/inventory:Z \ <3>
24902490
-e INVENTORY_FILE=/tmp/inventory \ <3>
2491-
-e PLAYBOOK_FILE=playbooks/byo/config.yml \ <4>
2491+
-e PLAYBOOK_FILE=playbooks/deploy_cluster.yml \ <4>
24922492
-e OPTS="-v" \ <5>
24932493
ifdef::openshift-enterprise[]
24942494
registry.access.redhat.com/openshift3/ose-ansible:v3.7
@@ -2533,8 +2533,8 @@ The inventory file can also be downloaded from a web server if you specify
25332533
the `INVENTORY_URL` environment variable, or generated dynamically using
25342534
`DYNAMIC_SCRIPT_URL` to specify an executable script that provides a
25352535
dynamic inventory.
2536-
<4> `-e PLAYBOOK_FILE=playbooks/byo/config.yml` specifies the playbook
2537-
to run (in this example, the BYO installer) as a relative path from the
2536+
<4> `-e PLAYBOOK_FILE=playbooks/deploy_cluster.yml` specifies the playbook
2537+
to run (in this example, the default installer) as a relative path from the
25382538
top level directory of *openshift-ansible* content. The full path from the
25392539
RPM can also be used, as well as the path to any other playbook file in
25402540
the container.
@@ -2545,7 +2545,7 @@ inside the container.
25452545
[[running-the-advanced-installation-individual-components]]
25462546
=== Running Individual Component Playbooks
25472547

2548-
The main installation playbook *_{pb-prefix}playbooks/byo/config.yml_* runs a
2548+
The main installation playbook *_{pb-prefix}playbooks/deploy_cluster.yml_* runs a
25492549
set of individual component playbooks in a specific order, and the installer
25502550
reports back at the end what phases you have gone through. If the installation
25512551
fails during a phase, you are notified on the screen along with the errors from
@@ -2568,46 +2568,49 @@ playbook is run:
25682568
|Playbook Name |File Location
25692569

25702570
|Health Check
2571-
|*_{pb-prefix}playbooks/byo/openshift-checks/pre-install.yml_*
2571+
|*_{pb-prefix}playbooks/openshift-checks/pre-install.yml_*
25722572

25732573
|etcd Install
2574-
|*_{pb-prefix}playbooks/byo/openshift-etcd/config.yml_*
2574+
|*_{pb-prefix}playbooks/openshift-etcd/config.yml_*
25752575

25762576
|NFS Install
2577-
|*_{pb-prefix}playbooks/byo/openshift-nfs/config.yml_*
2577+
|*_{pb-prefix}playbooks/openshift-nfs/config.yml_*
25782578

25792579
|Load Balancer Install
2580-
|*_{pb-prefix}playbooks/byo/openshift-loadbalancer/config.yml_*
2580+
|*_{pb-prefix}playbooks/openshift-loadbalancer/config.yml_*
25812581

25822582
|Master Install
2583-
|*_{pb-prefix}playbooks/byo/openshift-master/config.yml_*
2583+
|*_{pb-prefix}playbooks/openshift-master/config.yml_*
25842584

25852585
|Master Additional Install
2586-
|*_{pb-prefix}playbooks/byo/openshift-master/additional_config.yml_*
2586+
|*_{pb-prefix}playbooks/openshift-master/additional_config.yml_*
25872587

25882588
|Node Install
2589-
|*_{pb-prefix}playbooks/byo/openshift-node/config.yml_*
2589+
|*_{pb-prefix}playbooks/openshift-node/config.yml_*
25902590

25912591
|GlusterFS Install
2592-
|*_{pb-prefix}playbooks/byo/openshift-glusterfs/config.yml_*
2592+
|*_{pb-prefix}playbooks/openshift-glusterfs/config.yml_*
25932593

25942594
|Hosted Install
2595-
|*_{pb-prefix}playbooks/byo/openshift-cluster/openshift-hosted.yml_*
2595+
|*_{pb-prefix}playbooks/openshift-hosted/config.yml_*
2596+
2597+
|Web Console Install
2598+
|*_{pb-prefix}playbooks/openshift-web-console/config.yml_*
25962599

25972600
|Metrics Install
2598-
|*_{pb-prefix}playbooks/byo/openshift-cluster/openshift-metrics.yml_*
2601+
|*_{pb-prefix}playbooks/openshift-metrics/config.yml_*
25992602

26002603
|Logging Install
2601-
|*_{pb-prefix}playbooks/byo/openshift-cluster/openshift-logging.yml_*
2604+
|*_{pb-prefix}playbooks/openshift-logging/config.yml_*
26022605

26032606
|Prometheus Install
2604-
|*_{pb-prefix}playbooks/byo/openshift-cluster/openshift-prometheus.yml_*
2607+
|*_{pb-prefix}playbooks/openshift-prometheus/config.yml_*
26052608

26062609
|Service Catalog Install
2607-
|*_{pb-prefix}playbooks/byo/openshift-cluster/service-catalog.yml_*
2610+
|*_{pb-prefix}playbooks/openshift-service-catalog/config.yml_*
26082611

26092612
|Management Install
2610-
|*_{pb-prefix}playbooks/byo/openshift-management/config.yml_*
2613+
|*_{pb-prefix}playbooks/openshift-management/config.yml_*
26112614
|===
26122615

26132616
[[advanced-verifying-the-installation]]

‎install_config/install/stand_alone_registry.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ After you have configured Ansible by defining an inventory file in
275275
following playbook:
276276

277277
----
278-
# ansible-playbook /usr/share/ansible/openshift-ansible/playbooks/byo/config.yml
278+
# ansible-playbook /usr/share/ansible/openshift-ansible/playbooks/deploy_cluster.yml
279279
----
280280

281281
[NOTE]

‎install_config/redeploying_certificates.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ To redeploy master, etcd, and node certificates using the current
289289

290290
----
291291
$ ansible-playbook -i <inventory_file> \
292-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/redeploy-certificates.yml
292+
/usr/share/ansible/openshift-ansible/playbooks/redeploy-certificates.yml
293293
----
294294

295295
[[redeploying-new-custom-ca]]
@@ -336,7 +336,7 @@ step.
336336
+
337337
----
338338
$ ansible-playbook -i <inventory_file> \
339-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/redeploy-openshift-ca.yml
339+
/usr/share/ansible/openshift-ansible/playbooks/openshift-master/redeploy-openshift-ca.yml
340340
----
341341

342342
With the new {product-title} CA in place, you can then use the
@@ -366,7 +366,7 @@ To redeploy a newly generated etcd CA:
366366
+
367367
----
368368
$ ansible-playbook -i <inventory_file> \
369-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/redeploy-etcd-ca.yml
369+
/usr/share/ansible/openshift-ansible/playbooks/openshift-etcd/redeploy-ca.yml
370370
----
371371

372372
With the new etcd CA in place, you can then use the
@@ -385,7 +385,7 @@ file:
385385

386386
----
387387
$ ansible-playbook -i <inventory_file> \
388-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/redeploy-master-certificates.yml
388+
/usr/share/ansible/openshift-ansible/playbooks/openshift-master/redeploy-certificates.yml
389389
----
390390

391391
[[redeploying-etcd-certificates]]
@@ -404,7 +404,7 @@ file:
404404

405405
----
406406
$ ansible-playbook -i <inventory_file> \
407-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/redeploy-etcd-certificates.yml
407+
/usr/share/ansible/openshift-ansible/playbooks/openshift-etcd/redeploy-certificates.yml
408408
----
409409

410410
[[redeploying-node-certificates]]
@@ -418,7 +418,7 @@ file:
418418

419419
----
420420
$ ansible-playbook -i <inventory_file> \
421-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/redeploy-node-certificates.yml
421+
/usr/share/ansible/openshift-ansible/playbooks/openshift-node/redeploy-certificates.yml
422422
----
423423

424424
[[redeploying-registry-router-certificates]]
@@ -439,7 +439,7 @@ inventory file:
439439

440440
----
441441
$ ansible-playbook -i <inventory_file> \
442-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/redeploy-registry-certificates.yml
442+
/usr/share/ansible/openshift-ansible/playbooks/openshift-hosted/redeploy-registry-certificates.yml
443443
----
444444

445445
[[redeploying-router-certificates]]
@@ -450,7 +450,7 @@ inventory file:
450450

451451
----
452452
$ ansible-playbook -i <inventory_file> \
453-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/redeploy-router-certificates.yml
453+
/usr/share/ansible/openshift-ansible/playbooks/openshift-hosted/redeploy-router-certificates.yml
454454
----
455455

456456
[[redeploying-custom-registry-or-router-certificates]]

‎install_config/storage_examples/containerized_heketi_with_dedicated_gluster.adoc

+7-1
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,13 @@ $ gluster volume info
224224
== Dynamically Provision a Volume
225225
[NOTE]
226226
====
227-
If you installed {product-title} by using the link:https://github.com/openshift/openshift-ansible/tree/master/inventory/byo[BYO (Bring your own) OpenShift Ansible inventory configuration files] for either link:https://github.com/openshift/openshift-ansible/blob/master/inventory/byo/hosts.byo.glusterfs.native.example[native] or link:https://github.com/openshift/openshift-ansible/blob/master/inventory/byo/hosts.byo.glusterfs.external.example[external] GlusterFS instance, the GlusterFS StorageClass automatically get created during the installation. For such cases you can skip the following storage class creation steps and directly proceed with creating persistent volume claim instruction.
227+
If you installed {product-title} by using the
228+
link:https://github.com/openshift/openshift-ansible/tree/master/inventory/[OpenShift Ansible example inventory configuration files] for either
229+
link:https://github.com/openshift/openshift-ansible/blob/master/inventory/hosts.glusterfs.native.example[native] or
230+
link:https://github.com/openshift/openshift-ansible/blob/master/inventory/hosts.glusterfs.external.example[external]
231+
GlusterFS instance, the GlusterFS StorageClass automatically gets created during
232+
the installation. For such cases you can skip the following storage class creation
233+
steps and directly proceed with creating persistent volume claim instruction.
228234
====
229235

230236
. Create a `StorageClass` object definition. The following definition is based on the

‎install_config/upgrading/automated_upgrades.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ xref:../../install_config/install/advanced_install.adoc#install-config-install-a
559559
+
560560
----
561561
# ansible-playbook -i </path/to/inventory/file> \
562-
/usr/share/ansible/openshift-ansible/playbooks/byo/openshift-cluster/service-catalog.yml
562+
/usr/share/ansible/openshift-ansible/playbooks/openshift-service-catalog/config.yml
563563
----
564564
// end::automated-service-catalog-upgrade-steps[]
565565

0 commit comments

Comments
 (0)