starlingx/ansible-playbooks README improvement

This story shall update the README file of a few most used StarlingX
repos.

Test Plan: N/A

Story: 2010814
Task: 48340

Change-Id: Id7a2ee4c8792a2202f62ecc8cdf31e3fab6dcc90
Signed-off-by: Roger Ferraz <rogerio.ferraz@encora.com>
This commit is contained in:
Roger Ferraz 2023-07-10 13:00:38 -03:00
parent 47a3a4826f
commit 92671d6537

View File

@ -1,43 +1,43 @@
===================== =====================
stx-ansible-playbooks stx-ansible-playbooks
===================== =====================
StarlingX Bootstrap and Deployment Ansible [1]_ Playbooks
StarlingX Bootstrap and Deployment Playbooks
Execution environment Execution environment
===================== =====================
- Unix like OS (recent Linux based distributions, MacOS, Cygwin) - Unix like OS (recent Linux based distributions, MacOS, Cygwin)
- Python 2.7 - Python 3.8 and later
Additional Required Packages Additional Required Packages
============================ ============================
The playbooks in this repo have been verified with the following versions of Ansible In addition to the pakages listed in `requirements.txt` and `test-requirements.txt`,
and StarlingX playbooks dependencies: the following packages are required to run the playbooks remotely:
- sshpass 1.06 - python3-pexpect
- python2-ptyprocess 0.5 - python3-ptyprocess
- python2-pexpect 4.6 - sshpass
- python2-netaddr 0.7
- ``ansible`` 2.7.5
Supported StarlingX Releases Supported StarlingX Releases
============================ ============================
The playbooks in this repo are compatible with the following StarlingX releases: The playbooks are compatible with StarlingX R8.0 and later.
- 20.01
Executing StarlingX Playbooks Executing StarlingX Playbooks
============================= =============================
Executing Bootstrap Playbook Bootstrap Playbook
---------------------------- ------------------
Please refer to ``StarlingX Deployment Guides``, section **Configuration controller-0** For instructions on how to set up and execute the bootstrap playbook from
of the respective system configuration for instructions on how to set up and execute another host, please refer to the StarlingX Documentation [2]_, at
the bootstrap playbook from another host. ``Installation Guides``, section **Configure controller-0** of the respective
system deployment type.
Developer Notes
===============
This repository is not intended to be developed standalone, but rather as part
of the StarlingX Source System, which is defined by the StarlingX manifest [3]_.
References References
========== ==========
.. [1] https://docs.ansible.com/ansible/2.7/installation_guide/index.html .. [1] https://docs.ansible.com/ansible/latest/installation_guide
.. [2] https://docs.starlingx.io/deployment_guides/index.html .. [2] https://docs.starlingx.io
.. [3] https://opendev.org/starlingx/manifest.git