Clean up unused cyborg-spec document
There are lots of redundant document for cyborg-spec, cyborg-spec is not a service but just a document repo, so we don't need install, user, admin documents. This patch try to cleanup these unused document, and make the index more clear. Change-Id: Ic50ee7ede3cdf4f59fcffefbb161026b774bdd5d
This commit is contained in:
Yikun Jiang
parent
dd55eb40f6
commit
24d2b6cdb2
|
|
@ -1,5 +0,0 @@
|
|||
====================
|
||||
Administrators guide
|
||||
====================
|
||||
|
||||
Administrators guide of cyborg-specs.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
================================
|
||||
Command line interface reference
|
||||
================================
|
||||
|
||||
CLI reference of cyborg-specs.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
=============
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Configuration of cyborg-specs.
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
===========================
|
||||
Contributor Documentation
|
||||
===========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributing
|
||||
|
||||
|
|
@ -3,28 +3,64 @@
|
|||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
=====================================
|
||||
Welcome to the documentation of specs
|
||||
=====================================
|
||||
============
|
||||
Cyborg Specs
|
||||
============
|
||||
|
||||
Contents:
|
||||
Train
|
||||
-----
|
||||
This section has a list of specs for the Train release.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
readme
|
||||
install/index
|
||||
library/index
|
||||
contributor/index
|
||||
configuration/index
|
||||
cli/index
|
||||
user/index
|
||||
admin/index
|
||||
reference/index
|
||||
specs/train/approved/*
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
Stein
|
||||
-----
|
||||
This section has a list of specs for the Stein release.
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/stein/approved/*
|
||||
|
||||
Rocky
|
||||
-----
|
||||
This section has a list of specs for the Rocky release.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/rocky/approved/*
|
||||
|
||||
Queens
|
||||
------
|
||||
This section has a list of specs for the Queens release.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/queens/approved/*
|
||||
|
||||
Pike
|
||||
----
|
||||
This section has a list of specs for the Pike release.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/pike/approved/*
|
||||
|
||||
Template
|
||||
--------
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
specs/template
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
2. Edit the ``/etc/specs/specs.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql+pymysql://specs:SPECS_DBPASS@controller/specs
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
Prerequisites
|
||||
-------------
|
||||
|
||||
Before you install and configure the cyborg-specs 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 ``specs`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
CREATE DATABASE specs;
|
||||
|
||||
* Grant proper access to the ``specs`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
GRANT ALL PRIVILEGES ON specs.* TO 'specs'@'localhost' \
|
||||
IDENTIFIED BY 'SPECS_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON specs.* TO 'specs'@'%' \
|
||||
IDENTIFIED BY 'SPECS_DBPASS';
|
||||
|
||||
Replace ``SPECS_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 ``specs`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack user create --domain default --password-prompt specs
|
||||
|
||||
* Add the ``admin`` role to the ``specs`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack role add --project service --user specs admin
|
||||
|
||||
* Create the specs service entities:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack service create --name specs --description "cyborg-specs" cyborg-specs
|
||||
|
||||
#. Create the cyborg-specs service API endpoints:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
cyborg-specs public http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
cyborg-specs internal http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
cyborg-specs admin http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
=============================
|
||||
cyborg-specs service overview
|
||||
=============================
|
||||
The cyborg-specs service provides...
|
||||
|
||||
The cyborg-specs service consists of the following components:
|
||||
|
||||
``specs-api`` service
|
||||
Accepts and responds to end user compute API calls...
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
=======================================
|
||||
cyborg-specs service installation guide
|
||||
=======================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
get_started.rst
|
||||
install.rst
|
||||
verify.rst
|
||||
next-steps.rst
|
||||
|
||||
The cyborg-specs service (specs) provides...
|
||||
|
||||
This chapter assumes a working setup of OpenStack following the
|
||||
`OpenStack Installation Tutorial
|
||||
<https://docs.openstack.org/project-install-guide/ocata/>`_.
|
||||
|
|
@ -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-specs 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-specs services and configure them to start when
|
||||
the system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable openstack-specs-api.service
|
||||
|
||||
# systemctl start openstack-specs-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-specs 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-specs services and configure them to start when
|
||||
the system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable openstack-specs-api.service
|
||||
|
||||
# systemctl start openstack-specs-api.service
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
.. _install-ubuntu:
|
||||
|
||||
Install and configure for Ubuntu
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the cyborg-specs
|
||||
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-specs services:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# service openstack-specs-api restart
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
.. _install:
|
||||
|
||||
Install and configure
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the
|
||||
cyborg-specs service, code-named specs, 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 specs 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-specs 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-specs service list
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
========
|
||||
Usage
|
||||
========
|
||||
|
||||
To use cyborg-specs in a project::
|
||||
|
||||
import specs
|
||||
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../../README.rst
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
==========
|
||||
References
|
||||
==========
|
||||
|
||||
References of cyborg-specs.
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../specs
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
===========
|
||||
Users guide
|
||||
===========
|
||||
|
||||
Users guide of cyborg-specs.
|
||||
|
|
@ -24,7 +24,6 @@ packages =
|
|||
|
||||
[build_sphinx]
|
||||
all-files = 1
|
||||
warning-is-error = 1
|
||||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
|
||||
|
|
|
|||
|
|
@ -1,60 +0,0 @@
|
|||
Cyborg Specs
|
||||
============
|
||||
|
||||
Template
|
||||
--------
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
template
|
||||
|
||||
Train
|
||||
-----
|
||||
This section has a list of specs for the Stein release.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
train/approved/*
|
||||
|
||||
Stein
|
||||
-----
|
||||
This section has a list of specs for the Stein release.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
stein/approved/*
|
||||
|
||||
Rocky
|
||||
-----
|
||||
This section has a list of specs for the Rocky release.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
rocky/approved/*
|
||||
|
||||
Queens
|
||||
------
|
||||
This section has a list of specs for the Queens release.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
queens/approved/*
|
||||
|
||||
Pike
|
||||
----
|
||||
This section has a list of specs for the Pike release.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
pike/approved/*
|
||||
|
|
@ -28,7 +28,7 @@ Use Cases
|
|||
---------
|
||||
|
||||
For instance, when the user requests FPGA resources, the scheduler will use
|
||||
placement agent [1]_ to select appropriate hosts that have the requested FPGA
|
||||
placement agent to select appropriate hosts that have the requested FPGA
|
||||
resources.
|
||||
|
||||
For instance, when Nova picks a device (GPU/FPGA/etc.) resource provider to
|
||||
|
|
|
|||
Loading…
Reference in New Issue