From dfa7983a7803e272ef571e518419c8816df6dc77 Mon Sep 17 00:00:00 2001 From: Sagi Shnaidman Date: Tue, 9 Jun 2020 13:13:47 +0300 Subject: [PATCH] Add notes to README about deps and versions Change-Id: Ied2ac325af5aee174fc0d20d9aada67a859fa81b --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index f26117eb..2cd7b732 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,29 @@ The collection includes the Openstack modules and plugins supported by Openstack ## Installation and Usage +### Installing dependencies + +For using Openstack Cloud collection firstly need to install `ansible` and `openstacksdk` Python modules on Ansible controller. +For example with pip: + +```bash +pip install ansible openstacksdk +``` + +OpenStackSDK has to be available to Ansible and to the Python interpreter on the host, where Ansible executes the module (target host). +Please note, that under some circumstances Ansible might invoke not standard Python interpreter on the target host. + +--- + +#### NOTE + +OpenstackSDK is better to be the last stable version. It should NOT be installed on Openstack nodes, +but rather on operators host (aka "Ansible controller"). OpenstackSDK from last version supports +operations on all Openstack cloud versions. Therefore OpenstackSDK module version doesn't have to match +Openstack cloud version usually. + +--- + ### Installing the Collection from Ansible Galaxy Before using the Openstack Cloud collection, you need to install the collection with the `ansible-galaxy` CLI: