ansible-playbooks/README.rst
Tee Ngo c7390f6300 Update repo README, add compatibility check, sample config files
In this commit:
  - Add execution environment, required additional packages,
    supported software releases, and links to Ansible installation
    as well as StarlingX deployment guides to repo README.rst
  - Add check for supported host software versions to bootstrap playbook
  - Add example files for a sample setup of 2 hosts, a site.yml and a
    secret file which the users can copy to the location of their
    choice and customize to suit their remote bootstrap requirements.

Story: 2004695
Task: 34753
Change-Id: I400021a5a460e1686ef717632c70123b2a93064a
Signed-off-by: Tee Ngo <tee.ngo@windriver.com>
2019-06-27 08:11:58 -04:00

43 lines
1.1 KiB
ReStructuredText

=====================
stx-ansible-playbooks
=====================
StarlingX Bootstrap and Deployment Playbooks
Execution environment
=====================
- Linux like OS (recent Linux based distributions, MacOS, Cygwin)
- Python 2.7
Additional Required Packages
============================
The playbooks in this repo have been verified with the following versions of Ansible
and StarlingX playbooks dependencies:
- sshpass 1.06
- python2-ptyprocess 0.5
- python2-pexpect 4.6
- ``ansible`` 2.7.5
Supported StarlingX Releases
============================
The playbooks in this repo are compatible with the following StarlingX releases:
- 19.01
Executing StarlingX Playbooks
=============================
Executing Bootstrap Playbook
----------------------------
Please refer to ``StarlingX Deployment Guides``, section **Configuration controller-0**
of the respective system configuration for instructions on how to set up and execute
the bootstrap playbook from another host.
References
==========
.. [1] https://docs.ansible.com/ansible/2.7/installation_guide/index.html
.. [2] https://docs.starlingx.io/deployment_guides/index.html