Install and use the murano client

The Application Catalog project provides a command-line client, python-muranoclient, which enables you to access the project API. For prerequisites, see Install the prerequisite software.

To install the latest murano CLI client, run the following command in your terminal:

$ pip install python-muranoclient

Discover the client version number

To discover the version number for the python-muranoclient, run the following command:

$ murano --version

To check the latest version, see Client library for Murano API.

Upgrade or remove the client

To upgrade or remove the python-muranoclient, use the corresponding commands.

To upgrade the client:

$ pip install --upgrade python-muranoclient

To remove the client:

$ pip uninstall python-muranoclient

Set environment variables

To use the murano client, you must set the environment variables. To do this, download and source the OpenStack RC file. For more information, see Download and source the OpenStack RC file.

Alternatively, create the PROJECT-openrc.sh file from scratch. For this, perform the following steps:

1. In a text editor, create a file named PROJECT-openrc.sh containing the following authentication information:

   export OS_USERNAME=user
   export OS_PASSWORD=password
   export OS_PROJECT_NAME=tenant
   export OS_USER_DOMAIN_NAME=Default
   export OS_PROJECT_DOMAIN_NAME=Default
   export OS_AUTH_URL=http://auth.example.com:5000/v3
   export MURANO_URL=http://murano.example.com:8082/
   

2. In the terminal, source the PROJECT-openrc.sh file. For example:

   $ . admin-openrc.sh
   

Once you have configured your authentication parameters, run murano help to see a complete list of available commands and arguments. Use murano help <sub_command> to get help on a specific subcommand.

See also

Set environment variables using the OpenStack RC file.

Bash completion

To get the latest bash completion script, download murano.bash_completion from the source repository and add it to your completion scripts.

If you are not aware of the completion scripts location, perform the following steps:

1. Create a new directory:

   $ mkdir -p ~/.bash_completion/
   

2. Create a file containing the bash completion script:

   $ curl https://opendev.org/openstack/python-muranoclient/raw/branch/master/tools/murano.bash_completion > ~/.bash_completion/murano.sh
   

3. Add the following code to the ~/.profile file:

   for file in $HOME/.bash_completion/*.sh; do
       if [ -f "$file" ]; then
           . "$file"
       fi
   done
   

4. In the current terminal, run:

   $ . ~/.bash_completion/murano.sh