6.1 Installing openstack-kolla-utils

This section shows you how to install and set up the openstack-kolla-utils package. This is the package that wraps the OpenStack CLI commands using a utility named docker-ostk.

To install openstack-kolla-utils :

  1. Set up an Oracle Linux host as described in Section 3.6, “Preparing a Master Node”.

  2. Install the openstack-kolla-utils package:

    # yum install openstack-kolla-utils

    The docker-ostk utility is now installed.

  3. The user which runs the docker-ostk utility must be a member of the docker group. To add an existing user to the docker group, enter:

    # usermod -aG docker username

    The user must log out and in again for the group setting to take effect.

    Caution

    Any member of the docker group has full (root) access to all containers in the deployment. If you add an unprivileged user to the docker group, you should consider the elevation in security granted with this access. Do not run the docker-ostk utility as the root user.

  4. Set the environment variables to use with docker-ostk. You can manually set the variables, or download a configuration file from Horizon.

    The variables used by docker-ostk are listed in the following table:

    Environment Variable

    Purpose

    OS_AUTH_URL

    Authentication URL.

    OS_TENANT_NAME

    Keystone tenant name.

    OS_USERNAME

    Keystone user name.

    OS_PASSWORD

    Keystone password.

    OS_PROJECT_NAME

    Keystone project name.

    OS_PROJECT_DOMAIN_ID

    Keystone domain ID containing the project.

    OS_USER_DOMAIN_ID

    Keystone user's domain ID.

    ENV_FILE

    The location and name of a file which contains key/value pairs. Used to pass additional environment variables to docker-ostk. Each key/value pair should be on a new line.

    OPENSTACK_UTILS_IMAGE

    Docker registry image name. The default is oracle/ol-openstack-utils:latest. You should not need to change this.

    The list of variables in this table is not a complete list. For more information on OpenStack Command Line variables, and a full list of variables you can use, see the OpenStack Keystone Command Line Utility documentation at:

    http://docs.openstack.org/developer/python-keystoneclient/man/keystone.html

    To manually set the environment variables, for each variable, enter:

    $ export variable_name=variable_value

    For example:

    $ export OS_AUTH_URL=http://10.0.0.10:5000/v2.0
    $ export OS_TENANT_NAME=admin
    $ export OS_PROJECT_NAME=admin
    $ export OS_USERNAME=admin
    $ export OS_PASSWORD=password

    To download a file which contains all the required environment variables:

    1. Log into Horizon.

    2. Select Project, select Compute, and then select Access & Security. Select the API Access subtab.

    3. Click Download OpenStack RC File and save this file to the host on which the openstack-kolla-utils package is installed.

    4. Source the file to load the environment variables:

      $ source admin-openrc.sh
      Please enter your OpenStack Password: 

      You are prompted to enter the OpenStack admin password. Enter the password and the environment variables are set up and ready for use with docker-ostk.