cPouta environment variables

Summary: The cPouta environment can be used conveniently from the command line interface. Authentication and correct endpoints are defined using configuration files and environment variables. Some of these are listed below.
Internet: https://docs.openstack.org/python-openstackclient/latest/cli/man/openstack.html

cPouta view

Description

Environments such as Allas, cPouta and Pukki can be configured from the command line interface. To enable this, a number of environment variables must be defined.

There are a couple of bash scripts available to help you set up the right variables. For Allas, allas_conf and for cPouta, OpenStack RC File.

Configuration can also be done manually, e.g. setting up application credentials and exporting them as local variables.

Tutorial

The tutorial Enable API access to cPouta from the CLI and create application credentials will guide you through the process in practice.

Below is a table of some environment variables that you may encounter.

Variable	Short description
`OS_AUTH_URL`	The URL for the OpenStack Identity API endpoint.
`OS_PROJECT_ID`	cPouta generated ID of the project. Basically interchangeable with `OS_PROJECT_NAME`.
`OS_PROJECT_NAME`	The name of the project (`Unix group` information in MyCSC Project view) in cPouta.
`OS_USER_DOMAIN_NAME`	The domain name of the user for Identity service operations. Default value `Default`.
`OS_PROJECT_DOMAIN_ID`	The domain ID of the project (tenant). Default value `default`.
`OS_USERNAME`	The username for authentication, basically CSC account's username. Set by the `allas_conf` and `openrc` scripts.
`OS_PASSWORD`	The clear text password for authentication. Used by `openrc` script.
`OS_INTERFACE`	The interface type for the URL of the service endpoint (public, internal, or admin). Should be `public`.
`OS_IDENTITY_API_VERSION`	The version of the Identity API to use (e.g., "3").
`OS_REGION_NAME`	The region name of the cloud services. By default `regionOne`.
`OS_TENANT_ID`	The ID of the tenant (project). Equivalent to `OS_PROJECT_ID` and used in older versions of OpenStack.
`OS_TENANT_NAME`	The name of the tenant (project). Equivalent to `OS_PROJECT_NAME` and used in older versions of OpenStack.
`OS_STORAGE_URL`	The endpoint URL for the Swift Object Storage service. Set by the `allas_conf` script.
`OS_AUTH_TOKEN`	This variable is used to store the authentication token received from the OpenStack Identity service (Keystone) after a successful authentication process. Set by the `allas_conf` script.
`OS_APPLICATION_CREDENTIAL_ID`	Can be used in place of `OS_USERNAME` for depersonalised credentials.
`OS_APPLICATION_CREDENTIAL_SECRET`	Goes together with `OS_APPLICATION_CREDENTIAL_ID` and replaces `OS_AUTH_TOKEN` and `OS_PASSWORD`.