Skip to content

Commit

Permalink
Made wording in intro section consistent with README
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
  • Loading branch information
andy-maier committed Nov 9, 2020
1 parent eeefe06 commit b67cc5f
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions docs/source/intro.rst
Expand Up @@ -311,25 +311,26 @@ check mode:
Example playbooks
-----------------
The ibm.zhmc Ansible Galaxy collection includes example playbooks, which can
be found in directory
``$HOME/.ansible/collections/ansible_collections/ibm/zhmc/playbooks``. Some
of them are:
After having installed the ibm.zhmc Ansible Galaxy collection, you find the
example playbooks in folder ``ibm/zhmc/playbooks/`` of your local Ansible
collection directory (e.g. ``$HOME/.ansible/collections/ansible_collections/``),
for example:
* ``create_partition.yml`` creates a partition with a NIC, HBA and virtual
function to an accelerator adapter.
* ``delete_partition.yml`` deletes a partition.
* ``vars_example.yml`` is an example variable file defining variables such as
CPC name, partition name, etc.
These example playbooks include two other files for defining credentials and
other variables:
* ``vault_example.yml`` is an example password vault file defining variables
for authenticating with the HMC.
* ``vars.yml`` defines variables such as CPC name, partition name, etc. It does
not exist in that directory but can be copied from ``vars_example.yml``,
changing the variables to your needs.
Before you run a playbook, copy ``vars_example.yml`` to ``vars.yml`` and
``vault_example.yml`` to ``vault.yml`` and change the variables in those files
as needed.
* ``vault.yml`` is a password vault file defining variables for authenticating
with the HMC. It does not exist in that directory but can be copied from
``vault_example.yml``, changing the variables to your needs.
Then, run the playbooks:
Expand Down

0 comments on commit b67cc5f

Please sign in to comment.