CLI supporting kolla-ansible deployment project
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gujin 7cc4b7f624 Move the stestr command into testenv section 6 days ago
doc Remove the doc/build 6 days ago
kolla-cli/locale Updating the cli to work against kolla-ansible 1 year ago
kolla_cli change the description of the class 1 week ago
tools Merge "Check passwords.yml exist before init action" 1 year ago
.gitignore Add cover into zuul check 4 days ago
.gitreview OpenDev Migration Patch 2 months ago
.stestr.conf Align tests with how functional tests are handled 1 year ago
.zuul.yaml Rename functional to functional-py27 and add functional-py37 1 day ago
LICENSE Adding the Apache LICENSE file, required to be included in the RPM 3 years ago
README.rst Replace git.openstack.org URLs with opendev.org URLs 1 week ago
babel.cfg Initial commit 4 years ago
builddocs.sh Added initial sphinx documentation support for the python api 3 years ago
cli_setup.py Add Python 3 Train unit tests 5 days ago
lower-constraints.txt Add lower-constraints.txt for kolla-cli 4 days ago
requirements.txt Add lower-constraints check into zuul 4 days ago
setup.cfg Add Python 3 Train unit tests 5 days ago
setup.py fixed the property code to work with mainstream kolla changes. ordered property output. 3 years ago
test-requirements.txt Add debug env into tox 1 day ago
tox.ini Move the stestr command into testenv section 1 day ago

README.rst

Kolla-CLI

The Kolla-CLI project provides the ability to more easily manage Kolla-Ansible deployments. It provides both a CLI and a python API that you can use to configure and deploy OpenStack using Kolla-Ansible.

Kolla-Ansible requires that hosts, groups, and services are specified in an inventory file. With Kolla-CLI, you can add/remove hosts, change group associations, etc from the CLI or API. Kolla-Ansible also maintains passwords and various configuration variables in a variety of global, group and host files. With Kolla-CLI, you can now view and change these from the CLI/API.

Finally, Kolla-CLI provides commands to setup the SSH keys on hosts, run deployments and perform upgrades.

Installing

The installation process below assumes that the kolla-ansible repository exists at the same level as the kolla-cli repository. This is made clear in the cli_setup.py script which makes a relative '../' reference to the kolla-ansible repository. If your kolla-ansible directory is somewhere else then that location can be passed as an argument to the cli_setup.py script. The location on the system where the kolla-cli expects the kolla-ansible files to be and installs them to can be tweaked by setting the KOLLA_HOME and KOLLA_ETC environment variables before running the cli_setup.py script, and while running the kolla-cli command itself. The default value for KOLLA_HOME is /usr/share/kolla-ansible and the default value for KOLLA_ETC is /etc/kolla.

The following steps can be used to build / run the kolla-cli

  • install ansible and docker
  • virtualenv .venv
  • . .venv/bin/activate
  • pip install -r requirements.txt
  • python setup.py install
  • python ./cli_setup.py
  • kolla-cli

At that point you will be dropped into the kollacli shell where you can run commands like help or ? to see what commands are available and any of the sub commands can be executed directly.

Alternately you can not use the shell and just execute commands directly via kollacli host add, etc.

If you make changes to the i18n strings (denoted by methods like _("message")) make sure to re-generate the i18n files with the python setup.py extract_messages command and check in the files generated in openstack-kollacli.

API

To use the API, import the ClientAPI into your module:

from kolla_cli.api.client import ClientApi

Then define a global:

CLIENT = ClientApi()

And then you can use that global to execute API commands, for example, to add a host to the inventory:

CLIENT.host_add(['host_name'])

Getting Involved

Need a feature? Find a bug? Let us know! Contributions are much appreciated and should follow the standard Gerrit workflow.

  • We communicate using the #openstack-kolla irc channel.
  • File bugs, blueprints, track releases, etc on Launchpad.
  • Attend weekly meetings.
  • Contribute code.

Contributors

Check out who is contributing code and contributing reviews.

Troubleshooting

If you get an error about missing python.h install the python-dev package via apt-get or yum or whatever mechanism is appropriate for your platform.