Skip to content

Commit 5508927

Browse files
committed
suggested wording changes
Signed-off-by: Andrew Twydell <[email protected]>
1 parent c51654c commit 5508927

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

docs/source/playbooks.rst

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ An `Ansible playbook`_ consists of organized instructions that define work for
2121
a managed node (host) to be managed with Ansible.
2222

2323
`Samples`_ that contains multiple example playbooks are included in the
24-
`CICS samples repository`_. The sample playbooks are for reference and can be run
24+
`Ansible Z playbook repository`_. The sample playbooks are for reference and can be run
2525
with the ``ansible-playbook`` command with some modification to their **inventory**,
2626
**ansible.cfg** and **group_vars** as well as updates to their module parameters
2727
to reference your CICS artifacts and configuration.
@@ -36,7 +36,7 @@ refer to the installation path as ``~/.ansible/collections/ibm/ibm_zos_cics``.
3636
https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html#playbooks-intro
3737
.. _Samples:
3838
https://github.com/IBM/z_ansible_collections_samples/tree/main/zos_subsystems/cics
39-
.. _CICS samples repository:
39+
.. _Ansible Z playbook repository:
4040
https://github.com/IBM/z_ansible_collections_samples
4141
.. _installation documentation:
4242
installation.html
@@ -85,9 +85,9 @@ list or group of lists known as an `inventory`_. Once the inventory is defined,
8585
you can use `patterns`_ to select the hosts or groups that you want Ansible to
8686
run against.
8787

88-
Included in the `CMCI samples repository`_ is a `sample inventory file`_
89-
that can be used to manage your nodes with a little modification. This
90-
inventory file should be included when running the sample playbook.
88+
Included in the CICS `deploy program sample`_ is an example `inventory file`_
89+
which shows how host information is supplied to Ansible. It looks like the
90+
following:
9191

9292
.. code-block:: yaml
9393
@@ -119,11 +119,11 @@ to set the port for a host can be reviewed in the
119119

120120
.. _inventory:
121121
https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html
122-
.. _CMCI samples repository:
123-
https://github.com/IBM/z_ansible_collections_samples/blob/main/zos_subsystems/cics/cmci
124122
.. _patterns:
125123
https://docs.ansible.com/ansible/latest/user_guide/intro_patterns.html#intro-patterns
126-
.. _sample inventory file:
124+
.. _deploy program sample:
125+
https://github.com/IBM/z_ansible_collections_samples/blob/main/zos_subsystems/cics/cmci/deploy_program
126+
.. _inventory file:
127127
https://github.com/IBM/z_ansible_collections_samples/blob/main/zos_subsystems/cics/cmci/deploy_program/inventory.yml
128128
.. _FAQ:
129129
https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#running-on-z-os
@@ -137,8 +137,9 @@ Group_vars
137137

138138
Although you can store variables in the inventory file, storing separate host
139139
and group variables files may help you organize your variable values more
140-
easily. Included with the sample playbook is a sample variables
141-
file `zos_host.yml`_.
140+
easily. An example of one of these variable files is the `zos_host.yml`_
141+
file included with the `deploy_program sample`_, which is used to provide the
142+
required environment variables.
142143

143144
The value for the property **BPXK_AUTOCVT** must be configured to ``ON``.
144145

@@ -178,6 +179,8 @@ the playbook as well as the following:
178179

179180
.. _zos_host.yml:
180181
https://github.com/IBM/z_ansible_collections_samples/blob/main/zos_subsystems/cics/cmci/deploy_program/host_vars/zos_host.yml
182+
.. _deploy_program sample:
183+
https://github.com/IBM/z_ansible_collections_samples/blob/main/zos_subsystems/cics/cmci/deploy_program
181184

182185

183186

@@ -225,7 +228,7 @@ the directory containing the playbook you want to run. For example:
225228

226229
Use the Ansible command ``ansible-playbook`` to run the sample playbook. The
227230
command syntax is ``ansible-playbook -i <inventory> <playbook>`` which, using
228-
the example above of deploy_program, is
231+
the example above of ``deploy_program``, is
229232
``ansible-playbook -i inventory deploy_program.yaml``.
230233

231234
This command assumes that the controller's public SSH key has been shared with

0 commit comments

Comments
 (0)