Cleanup after api-quick-start import
Remove extra whitespace, line wrap overlong lines, convert too long table to list-table, remove all setup.cfg files since we don't need them anymore. Change-Id: Icb0dc37c21927ecc6de163ae1b0245aea9b9c202
This commit is contained in:
Andreas Jaeger
parent
a95821b542
commit
19db787551
@ -1,22 +0,0 @@
|
|||||||
[metadata]
|
|
||||||
name = OpenStack API Documentation
|
|
||||||
summary = OpenStack API Documentation
|
|
||||||
description-file =
|
|
||||||
README.rst
|
|
||||||
author = OpenStack Documentation
|
|
||||||
author-email = openstack-docs@lists.openstack.org
|
|
||||||
home-page = https://developer.openstack.org/
|
|
||||||
classifier =
|
|
||||||
Intended Audience :: Developers
|
|
||||||
License :: OSI Approved :: Apache Software License
|
|
||||||
|
|
||||||
[build_sphinx]
|
|
||||||
all_files = 1
|
|
||||||
build-dir = build
|
|
||||||
source-dir = source
|
|
||||||
|
|
||||||
[pbr]
|
|
||||||
warnerrors = True
|
|
||||||
|
|
||||||
[wheel]
|
|
||||||
universal = 1
|
|
||||||
@ -46,44 +46,45 @@ Authenticate
|
|||||||
|
|
||||||
The payload of credentials to authenticate contains these parameters:
|
The payload of credentials to authenticate contains these parameters:
|
||||||
|
|
||||||
+-----------------------+----------------+--------------------------------------+
|
.. list-table:: Credential parameters
|
||||||
| Parameter | Type | Description |
|
:widths: 10 10 40
|
||||||
+=======================+================+======================================+
|
:header-rows: 1
|
||||||
| *User Domain* | string | The Domain of the user. |
|
|
||||||
| (required) | | |
|
|
||||||
+-----------------------+----------------+--------------------------------------+
|
|
||||||
| username (required) | string | The user name. If you do not provide |
|
|
||||||
| | | a user name and password, you must |
|
|
||||||
| | | provide a token. |
|
|
||||||
+-----------------------+----------------+--------------------------------------+
|
|
||||||
| password (required) | string | The password for the user. |
|
|
||||||
+-----------------------+----------------+--------------------------------------+
|
|
||||||
| *Project Domain* | string | The Domain of the project. This is a |
|
|
||||||
| (optional) | | required part of the scope object. |
|
|
||||||
+-----------------------+----------------+--------------------------------------+
|
|
||||||
| *Project Name* | string | The project name. Both the |
|
|
||||||
| (optional) | | *Project ID* and *Project Name* |
|
|
||||||
| | | are optional. |
|
|
||||||
+-----------------------+----------------+--------------------------------------+
|
|
||||||
| *Project ID* | string | The project ID. Both the *project ID*|
|
|
||||||
| (optional) | | and *Project Name* are optional. But |
|
|
||||||
| | | one of them is required along with |
|
|
||||||
| | | the *Project Domain*. They are |
|
|
||||||
| | | wrapped under a scope object. |
|
|
||||||
| | | If you do not know the project name |
|
|
||||||
| | | or ID, send a request without any |
|
|
||||||
| | | scope object. |
|
|
||||||
+-----------------------+----------------+--------------------------------------+
|
|
||||||
|
|
||||||
|
* - Parameter
|
||||||
|
- Type
|
||||||
|
- Description
|
||||||
|
* - *User Domain* (required)
|
||||||
|
- string
|
||||||
|
- The Domain of the user.
|
||||||
|
* - username (required)
|
||||||
|
- string
|
||||||
|
- The user name. If you do not provide a user name and password, you
|
||||||
|
must provide a token.
|
||||||
|
* - password (required)
|
||||||
|
- string
|
||||||
|
- The password for the user.
|
||||||
|
* - *Project Domain* (optional)
|
||||||
|
- string
|
||||||
|
- The Domain of the project. This is a required part of the scope object.
|
||||||
|
* - *Project Name* (optional)
|
||||||
|
- string
|
||||||
|
- The project name. Both the *Project ID* and *Project Name* are optional.
|
||||||
|
* - *Project ID* (optional)
|
||||||
|
- string
|
||||||
|
- The project ID. Both the *project ID* and *Project Name* are
|
||||||
|
optional. But one of them is required along with the *Project
|
||||||
|
Domain*. They are wrapped under a scope object. If you do not know
|
||||||
|
the project name or ID, send a request without any scope object.
|
||||||
|
|
||||||
In a typical OpenStack deployment that runs Identity, you can specify your
|
In a typical OpenStack deployment that runs Identity, you can specify your
|
||||||
project name, and user name and password credentials to authenticate.
|
project name, and user name and password credentials to authenticate.
|
||||||
|
|
||||||
First, export your project name to the ``OS_PROJECT_NAME`` environment variable,
|
First, export your project name to the ``OS_PROJECT_NAME`` environment
|
||||||
your project domain name to the ``OS_PROJECT_DOMAIN_NAME`` environment variable,
|
variable, your project domain name to the ``OS_PROJECT_DOMAIN_NAME``
|
||||||
your user name to the ``OS_USERNAME`` environment variable, your password to the
|
environment variable, your user name to the ``OS_USERNAME``
|
||||||
``OS_PASSWORD`` environment variable and your user domain name to the
|
environment variable, your password to the ``OS_PASSWORD`` environment
|
||||||
``OS_USER_DOMAIN_NAME`` environment variable.
|
variable and your user domain name to the ``OS_USER_DOMAIN_NAME``
|
||||||
|
environment variable.
|
||||||
|
|
||||||
The example below uses an endpoint from an installation of Ocata by following
|
The example below uses an endpoint from an installation of Ocata by following
|
||||||
the installation guide. However, you can also use ``$OS_AUTH_URL`` as an
|
the installation guide. However, you can also use ``$OS_AUTH_URL`` as an
|
||||||
@ -192,14 +193,15 @@ though it can be configured differently - see
|
|||||||
the `expiration <https://docs.openstack.org/keystone/latest/configuration/config-options.html#token.expiration>`__ option in the
|
the `expiration <https://docs.openstack.org/keystone/latest/configuration/config-options.html#token.expiration>`__ option in the
|
||||||
the *Identity Service Configuration Guide*.
|
the *Identity Service Configuration Guide*.
|
||||||
|
|
||||||
Export the project name to the ``OS_PROJECT_NAME`` environment variable. For example:
|
Export the project name to the ``OS_PROJECT_NAME`` environment
|
||||||
|
variable. For example:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
export OS_PROJECT_NAME=demo
|
export OS_PROJECT_NAME=demo
|
||||||
|
|
||||||
Then, use the Compute API to list flavors, substituting the Compute API endpoint with
|
Then, use the Compute API to list flavors, substituting the Compute
|
||||||
one containing your project ID below:
|
API endpoint with one containing your project ID below:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
@ -572,4 +574,3 @@ command with the image and flavor IDs and the server name:
|
|||||||
For information about the default ports that the OpenStack components use,
|
For information about the default ports that the OpenStack components use,
|
||||||
see `Firewalls and default ports <https://docs.openstack.org/install-guide/firewalls-default-ports.html>`_
|
see `Firewalls and default ports <https://docs.openstack.org/install-guide/firewalls-default-ports.html>`_
|
||||||
in the *OpenStack Installation Guide*.
|
in the *OpenStack Installation Guide*.
|
||||||
|
|
||||||
|
|||||||
@ -167,7 +167,3 @@ To begin sending API requests, use one of the following methods:
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
api-quick-start
|
api-quick-start
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1,27 +0,0 @@
|
|||||||
[metadata]
|
|
||||||
name = openstackdocumentationcontributorguide
|
|
||||||
summary = OpenStack Documentation Contributor Guide
|
|
||||||
author = OpenStack
|
|
||||||
author-email = openstack-discuss@lists.openstack.org
|
|
||||||
home-page = https://docs.openstack.org/
|
|
||||||
classifier =
|
|
||||||
Environment :: OpenStack
|
|
||||||
Intended Audience :: Information Technology
|
|
||||||
Intended Audience :: Documentation Contributors
|
|
||||||
License :: OSI Approved :: Apache Software License
|
|
||||||
Operating System :: POSIX :: Linux
|
|
||||||
Topic :: Documentation
|
|
||||||
|
|
||||||
[global]
|
|
||||||
setup-hooks =
|
|
||||||
pbr.hooks.setup_hook
|
|
||||||
|
|
||||||
[files]
|
|
||||||
|
|
||||||
[build_sphinx]
|
|
||||||
warning-is-error = 1
|
|
||||||
build-dir = build
|
|
||||||
source-dir = source
|
|
||||||
|
|
||||||
[wheel]
|
|
||||||
universal = 1
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
[metadata]
|
|
||||||
name = openstackdocumentationglossary
|
|
||||||
summary = OpenStack Documentation Glossary
|
|
||||||
author = OpenStack
|
|
||||||
author-email = openstack-discuss@lists.openstack.org
|
|
||||||
home-page = https://docs.openstack.org/
|
|
||||||
classifier =
|
|
||||||
Environment :: OpenStack
|
|
||||||
Intended Audience :: Information Technology
|
|
||||||
Intended Audience :: Documentation Contributors
|
|
||||||
License :: OSI Approved :: Apache Software License
|
|
||||||
Operating System :: POSIX :: Linux
|
|
||||||
Topic :: Documentation
|
|
||||||
|
|
||||||
[global]
|
|
||||||
setup-hooks =
|
|
||||||
pbr.hooks.setup_hook
|
|
||||||
|
|
||||||
[files]
|
|
||||||
|
|
||||||
[build_sphinx]
|
|
||||||
warning-is-error = 1
|
|
||||||
build-dir = build
|
|
||||||
source-dir = source
|
|
||||||
|
|
||||||
[wheel]
|
|
||||||
universal = 1
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
[metadata]
|
|
||||||
name = virtualmachineimageguide
|
|
||||||
summary = OpenStack Virtual Machine Image Guide
|
|
||||||
author = OpenStack
|
|
||||||
author-email = openstack-discuss@lists.openstack.org
|
|
||||||
home-page = https://docs.openstack.org/
|
|
||||||
classifier =
|
|
||||||
Environment :: OpenStack
|
|
||||||
Intended Audience :: Information Technology
|
|
||||||
Intended Audience :: Cloud Architects
|
|
||||||
License :: OSI Approved :: Apache Software License
|
|
||||||
Operating System :: POSIX :: Linux
|
|
||||||
Topic :: Documentation
|
|
||||||
|
|
||||||
[global]
|
|
||||||
setup-hooks =
|
|
||||||
pbr.hooks.setup_hook
|
|
||||||
|
|
||||||
[files]
|
|
||||||
|
|
||||||
[build_sphinx]
|
|
||||||
warning-is-error = 1
|
|
||||||
source-dir = source
|
|
||||||
build-dir = build
|
|
||||||
|
|
||||||
[wheel]
|
|
||||||
universal = 1
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
[metadata]
|
|
||||||
name = openstackinstallguide
|
|
||||||
summary = OpenStack Installation Guides
|
|
||||||
author = OpenStack
|
|
||||||
author-email = openstack-discuss@lists.openstack.org
|
|
||||||
home-page = http://docs.openstack.org/
|
|
||||||
classifier =
|
|
||||||
Environment :: OpenStack
|
|
||||||
Intended Audience :: Information Technology
|
|
||||||
Intended Audience :: System Administrators
|
|
||||||
License :: OSI Approved :: Apache Software License
|
|
||||||
Operating System :: POSIX :: Linux
|
|
||||||
Topic :: Documentation
|
|
||||||
|
|
||||||
[global]
|
|
||||||
setup-hooks =
|
|
||||||
pbr.hooks.setup_hook
|
|
||||||
|
|
||||||
[files]
|
|
||||||
|
|
||||||
[build_sphinx]
|
|
||||||
warning-is-error = 1
|
|
||||||
build-dir = build
|
|
||||||
source-dir = source
|
|
||||||
|
|
||||||
[wheel]
|
|
||||||
universal = 1
|
|
||||||
2
tox.ini
2
tox.ini
@ -95,7 +95,7 @@ usedevelop = False
|
|||||||
[doc8]
|
[doc8]
|
||||||
# Settings for doc8:
|
# Settings for doc8:
|
||||||
# Ignore target directories and autogenerated files
|
# Ignore target directories and autogenerated files
|
||||||
ignore-path = doc/*/target,doc/*/build*,doc/api-quick-start/source/api-quick-start.rst
|
ignore-path = doc/*/target,doc/*/build*
|
||||||
# File extensions to use
|
# File extensions to use
|
||||||
extensions = .rst,.txt
|
extensions = .rst,.txt
|
||||||
# Maximal line length should be 79 but we have some overlong lines.
|
# Maximal line length should be 79 but we have some overlong lines.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user