From b9c88644bedf9d6cd79688a7d16959a868f7cbe8 Mon Sep 17 00:00:00 2001 From: csymons-suse Date: Tue, 4 Jun 2019 15:19:51 -0700 Subject: [PATCH] doc: explicitly refer to python3 as indicated in https://github.com/SUSE-Cloud/socok8s/pull/426 --- doc/source/contributor.rst | 2 +- doc/source/deployment/setup-deployer.rst | 2 +- doc/source/reference.rst | 4 ++-- doc/source/suse-ecp/ose-localhost.rst | 20 ++++++++++---------- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/source/contributor.rst b/doc/source/contributor.rst index 364df434f..307f47e01 100644 --- a/doc/source/contributor.rst +++ b/doc/source/contributor.rst @@ -138,7 +138,7 @@ Code Comments Code comments for variables should be used to explain the purpose of the variable. -Code comments for bash/python scripts should give guidance to the purpose of +Code comments for Bash/Python3 scripts should give guidance to the purpose of the code. This is important to provide context for reviewers before the patch has merged, and for later modifications to remind the contributors what the purpose was and why it was done that way. diff --git a/doc/source/deployment/setup-deployer.rst b/doc/source/deployment/setup-deployer.rst index dc7d5ab2a..f39155819 100644 --- a/doc/source/deployment/setup-deployer.rst +++ b/doc/source/deployment/setup-deployer.rst @@ -140,7 +140,7 @@ configuration file loading ARA plugins: .. code-block:: console - python -m ara.setup.ansible | tee ~/.ansible.cfg + python3 -m ara.setup.ansible | tee ~/.ansible.cfg For more details on the ARA web interface, see https://ara.readthedocs.io/en/stable/webserver.html. diff --git a/doc/source/reference.rst b/doc/source/reference.rst index d5e5750a8..7d6454868 100644 --- a/doc/source/reference.rst +++ b/doc/source/reference.rst @@ -121,7 +121,7 @@ situated in `openstack/loci/`. The `build.sh` script is a thin wrapper around Container Initiative (OCI) compliant images of OpenStack projects. It uses `docker build` to construct images from OpenStack sources. Their requirements are expressed in `bindep` files (`bindep.txt` for rpm/apt packages, `pydep.txt` -for python packages). The `build.sh` script runs `LOCI` for the master branch. +for Python3 packages). The `build.sh` script runs `LOCI` for the master branch. Other branches can be built using `build-{branchname}.sh` where `branchname` is the name of the OpenStack release (for example, `rocky`). See also :ref:`buildlociimages`. @@ -320,7 +320,7 @@ not. This adds a step for patching upstream code, builds images and then continues the deployment. ``SOCOK8S_USE_VIRTUALENV`` determines if the script should set up and use a -virtualenv for python and ansible requirements. Without this it is expected +virtualenv for Python3 and Ansible requirements. Without this it is expected that ansible and the requirements are installed via system packages. When ``SOCOK8S_DEVELOPER_MODE`` is set to True, this defaults to True, otherwise this defaults to False. diff --git a/doc/source/suse-ecp/ose-localhost.rst b/doc/source/suse-ecp/ose-localhost.rst index 497d60353..db7ac1ede 100644 --- a/doc/source/suse-ecp/ose-localhost.rst +++ b/doc/source/suse-ecp/ose-localhost.rst @@ -59,20 +59,20 @@ Install the following software on your `localhost`: * jq * ipcalc * git - * python-virtualenv + * python3-virtualenv Optionally, `localhost` can be preinstalled with the following software: * ansible>=2.7.0 - * python/python3-openstackclient - * python/python3-requests - * python/python3-jmespath - * python/python3-openstacksdk - * python/python3-netaddr - -Install the variant of the packages that matches the Python release that Ansible -is using. (for example, on openSUSE Tumbleweed, Ansible uses Python 3, so install -the "python3-" variant of the packages). + * python3-openstackclient + * python3-requests + * python3-jmespath + * python3-openstacksdk + * python3-netaddr + +SUSE Containerized OpenStack only supports the Python3 variant of packages. +Generally, the `python` command invokes Python version 2, which will not work +with SUSE Containerized OpenStack. If the optional software packages are not installed, they will be installed in a venv in |socok8s_workspace_default|\ `/.ansiblevenv`.