[Murano Docs] Install murano client
Adds the "Install the murano client" section to End User Guide. Change-Id: Id20f8b4236077067fc9064f1e1b0bffcb9eabe74
This commit is contained in:
parent
6bb81bbbf6
commit
19136cf293
86
doc/source/draft/enduser-guide/install_client.rst
Normal file
86
doc/source/draft/enduser-guide/install_client.rst
Normal file
@ -0,0 +1,86 @@
|
||||
.. _install-client:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
Install the murano client
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The Application Catalog project provides a command-line client,
|
||||
python-muiranoclient, which enables you to access the project API.
|
||||
For prerequisites, see `Install the prerequisite software <http://docs.openstack.org/cli-reference/common/cli_install_openstack_command_line_clients.html#install-the-prerequisite-software>`_.
|
||||
|
||||
To install the latest murano CLI client, run the following command in your
|
||||
terminal:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install python-muranoclient
|
||||
|
||||
Discover the client version number
|
||||
----------------------------------
|
||||
|
||||
To discover the version number for the python-muranoclient, run the following
|
||||
command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ murano --version
|
||||
|
||||
To check the latest version, see `Client library for Murano API <https://git.openstack.org/cgit/openstack/python-muranoclient>`_.
|
||||
|
||||
|
||||
Upgrade or remove the client
|
||||
----------------------------
|
||||
|
||||
To upgrade or remove the python-muranoclient, use the corresponding commands.
|
||||
|
||||
**To upgrade the client:**
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install --upgrade python-muranoclient
|
||||
|
||||
**To remove the client:**
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip uninstall python-muranoclient
|
||||
|
||||
Bash completion
|
||||
---------------
|
||||
|
||||
To get the latest bash completion script, download
|
||||
`murano.bash_completion <https://git.openstack.org/cgit/openstack/python-muranoclient/plain/tools/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:
|
||||
|
||||
#. Create a new directory:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ mkdir -p ~/.bash_completion/
|
||||
|
||||
#. Create a file containing the bash completion script:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ curl https://git.openstack.org/cgit/openstack/python-muranoclient/plain/tools/murano.bash_completion > ~/.bash_completion/murano.sh
|
||||
|
||||
#. Add the following code to the ``~/.profile`` file:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
for file in $HOME/.bash_completion/*.sh; do
|
||||
if [ -f "$file" ]; then
|
||||
. "$file"
|
||||
fi
|
||||
done
|
||||
|
||||
#. In the current terminal, run:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ source ~/.bash_completion/murano.sh
|
@ -13,6 +13,8 @@ the Application Catalog through the command-line interface (CLI).
|
||||
Using python-muranoclient, the CLI client for murano, you can easily manage
|
||||
your environments, packages, categories, and deploy environments.
|
||||
|
||||
.. include:: install_client.rst
|
||||
|
||||
Manage environments
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user