Update python-cyborgclient doc
1.Remove the wrong document 2.Update env api version Change-Id: Ieb88341a636a0d77d64986aff5a09eca05746fe7
This commit is contained in:
wangzh21
parent
16bdd7cccf
commit
480b8c2414
|
|
@ -81,12 +81,12 @@ params, but it's easier to just set them as environment variables::
|
|||
|
||||
You will also need to define the authentication url with ``--os-auth-url``
|
||||
and the version of the API with ``--os-accelerator-api-version``. Or set them
|
||||
as environment variables as well, ``OS_ACCELERATOR_API_VERSION=3``. If you
|
||||
as environment variables as well, ``OS_ACCELERATOR_API_VERSION=1``. If you
|
||||
are using Keystone, you need to set the ``OS_AUTH_URL`` to the keystone
|
||||
endpoint::
|
||||
|
||||
export OS_AUTH_URL=http://controller:5000/v3
|
||||
export OS_ACCELERATOR_API_VERSION=3
|
||||
export OS_ACCELERATOR_API_VERSION=1
|
||||
|
||||
Since Keystone can return multiple regions in the Service Catalog, you
|
||||
can specify the one you want with ``--os-region-name`` (or
|
||||
|
|
|
|||
|
|
@ -1,5 +0,0 @@
|
|||
=============
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Configuration of python-cyborgclient.
|
||||
|
|
@ -16,7 +16,6 @@ Contents:
|
|||
install/index
|
||||
library/index
|
||||
contributor/index
|
||||
configuration/index
|
||||
cli/index
|
||||
user/index
|
||||
admin/index
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
2. Edit the ``/etc/cyborgclient/cyborgclient.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql+pymysql://cyborgclient:CYBORGCLIENT_DBPASS@controller/cyborgclient
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
Prerequisites
|
||||
-------------
|
||||
|
||||
Before you install and configure the Cyborg Python Client service,
|
||||
you must create a database, service credentials, and API endpoints.
|
||||
|
||||
#. To create the database, complete these steps:
|
||||
|
||||
* Use the database access client to connect to the database
|
||||
server as the ``root`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``cyborgclient`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
CREATE DATABASE cyborgclient;
|
||||
|
||||
* Grant proper access to the ``cyborgclient`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
GRANT ALL PRIVILEGES ON cyborgclient.* TO 'cyborgclient'@'localhost' \
|
||||
IDENTIFIED BY 'CYBORGCLIENT_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON cyborgclient.* TO 'cyborgclient'@'%' \
|
||||
IDENTIFIED BY 'CYBORGCLIENT_DBPASS';
|
||||
|
||||
Replace ``CYBORGCLIENT_DBPASS`` with a suitable password.
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
exit;
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to
|
||||
admin-only CLI commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . admin-openrc
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``cyborgclient`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack user create --domain default --password-prompt cyborgclient
|
||||
|
||||
* Add the ``admin`` role to the ``cyborgclient`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack role add --project service --user cyborgclient admin
|
||||
|
||||
* Create the cyborgclient service entities:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack service create --name cyborgclient --description "Cyborg Python Client" cyborg python client
|
||||
|
||||
#. Create the Cyborg Python Client service API endpoints:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
cyborg python client public http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
cyborg python client internal http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
cyborg python client admin http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
=====================================
|
||||
Cyborg Python Client service overview
|
||||
=====================================
|
||||
The Cyborg Python Client service provides...
|
||||
|
||||
The Cyborg Python Client service consists of the following components:
|
||||
|
||||
``cyborgclient-api`` service
|
||||
Accepts and responds to end user compute API calls...
|
||||
|
|
@ -1,17 +1,12 @@
|
|||
===============================================
|
||||
Cyborg Python Client service installation guide
|
||||
===============================================
|
||||
=======================================
|
||||
Cyborg Python Client installation guide
|
||||
=======================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
At the command line::
|
||||
|
||||
get_started.rst
|
||||
install.rst
|
||||
verify.rst
|
||||
next-steps.rst
|
||||
$ pip install python-cyborgclient
|
||||
|
||||
The Cyborg Python Client service (cyborgclient) provides...
|
||||
Or, if you have virtualenvwrapper installed::
|
||||
|
||||
This chapter assumes a working setup of OpenStack following the
|
||||
`OpenStack Installation Tutorial
|
||||
<https://docs.openstack.org/project-install-guide/ocata/>`_.
|
||||
$ mkvirtualenv python-cyborgclient
|
||||
$ pip install python-cyborgclient
|
||||
|
|
|
|||
|
|
@ -1,34 +0,0 @@
|
|||
.. _install-obs:
|
||||
|
||||
|
||||
Install and configure for openSUSE and SUSE Linux Enterprise
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the Cyborg Python Client service
|
||||
for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1.
|
||||
|
||||
.. include:: common_prerequisites.rst
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install the packages:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# zypper --quiet --non-interactive install
|
||||
|
||||
.. include:: common_configure.rst
|
||||
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
Start the Cyborg Python Client services and configure them to start when
|
||||
the system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable openstack-cyborgclient-api.service
|
||||
|
||||
# systemctl start openstack-cyborgclient-api.service
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
.. _install-rdo:
|
||||
|
||||
Install and configure for Red Hat Enterprise Linux and CentOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
This section describes how to install and configure the Cyborg Python Client service
|
||||
for Red Hat Enterprise Linux 7 and CentOS 7.
|
||||
|
||||
.. include:: common_prerequisites.rst
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install the packages:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# yum install
|
||||
|
||||
.. include:: common_configure.rst
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
Start the Cyborg Python Client services and configure them to start when
|
||||
the system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable openstack-cyborgclient-api.service
|
||||
|
||||
# systemctl start openstack-cyborgclient-api.service
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
.. _install-ubuntu:
|
||||
|
||||
Install and configure for Ubuntu
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the Cyborg Python Client
|
||||
service for Ubuntu 14.04 (LTS).
|
||||
|
||||
.. include:: common_prerequisites.rst
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install the packages:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# apt-get update
|
||||
|
||||
# apt-get install
|
||||
|
||||
.. include:: common_configure.rst
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
Restart the Cyborg Python Client services:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# service openstack-cyborgclient-api restart
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
.. _install:
|
||||
|
||||
Install and configure
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the
|
||||
Cyborg Python Client service, code-named cyborgclient, on the controller node.
|
||||
|
||||
This section assumes that you already have a working OpenStack
|
||||
environment with at least the following components installed:
|
||||
.. (add the appropriate services here and further notes)
|
||||
|
||||
Note that installation and configuration vary by distribution.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
install-obs.rst
|
||||
install-rdo.rst
|
||||
install-ubuntu.rst
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
.. _next-steps:
|
||||
|
||||
Next steps
|
||||
~~~~~~~~~~
|
||||
|
||||
Your OpenStack environment now includes the cyborgclient service.
|
||||
|
||||
To add additional services, see
|
||||
https://docs.openstack.org/project-install-guide/ocata/.
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
.. _verify:
|
||||
|
||||
Verify operation
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Verify operation of the Cyborg Python Client service.
|
||||
|
||||
.. note::
|
||||
|
||||
Perform these commands on the controller node.
|
||||
|
||||
#. Source the ``admin`` project credentials to gain access to
|
||||
admin-only CLI commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . admin-openrc
|
||||
|
||||
#. List service components to verify successful launch and registration
|
||||
of each process:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack cyborg python client service list
|
||||
Loading…
Reference in New Issue