openstack/keystone
Code Issues Proposed changes

Refresh admin doc

Browse Source 
What this patch done:

1. Paste is removed from Keystone. The healthcheck middleware
now is enabled by default.
2. Role supports `description` property now.
3. `reader` and `member` role are added to bootstrap command.

Update the related doc.

Change-Id: Ic49d3b09cf0df8bc4b1096349e36bdee2f1da0ca
This commit is contained in:
wangxiyuan 2018-11-06 15:25:22 +08:00
parent 002128208c
commit 0abde0c35d
3 changed files with 28 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/source/admin/cli-manage-projects-users-and-roles.rst
View File

@ -240,13 +240,14 @@ Create the ``new-role`` role:
.. code-block:: console .. code-block:: console
$ openstack role create new-role $ openstack role create new-role
+-----------+----------------------------------+ +-------------+----------------------------------+
| Field | Value | | Field | Value |
+-----------+----------------------------------+ +-------------+----------------------------------+
| domain_id | None | | description | None |
| id | a34425c884c74c8881496dc2c2e84ffc | | domain_id | None |
| name | new-role | | id | a34425c884c74c8881496dc2c2e84ffc |
+-----------+----------------------------------+ | name | new-role |
+-------------+----------------------------------+
.. note:: .. note::
@ -351,13 +352,14 @@ View details for a specified role:
.. code-block:: console .. code-block:: console
$ openstack role show ROLE_NAME $ openstack role show ROLE_NAME
+-----------+----------------------------------+ +-------------+----------------------------------+
| Field | Value | | Field | Value |
+-----------+----------------------------------+ +-------------+----------------------------------+
| domain_id | None | | description | None |
| id | a34425c884c74c8881496dc2c2e84ffc | | domain_id | None |
| name | new-role | | id | a34425c884c74c8881496dc2c2e84ffc |
+-----------+----------------------------------+ | name | new-role |
+-------------+----------------------------------+
Remove a role Remove a role
------------- -------------

32
doc/source/admin/health-check-middleware.rst
View File

@ -1,28 +1,12 @@
Health Check middleware Health Check
======================= ============
This health check middleware allows an operator to configure the endpoint URL Health check mechanism allows an operator to configure the endpoint URL that
that will provide information to a load balancer if the given API endpoint at will provide information to a load balancer if the given API endpoint at the
the node should be available or not. node should be available or not.
To enable the health check middleware, it must occur in the beginning of the It's enabled by default in Keystone using the functions from `oslo.middleware`.
application pipeline. And the URL is ``/healthcheck``.
The health check middleware should be placed in your
``keystone-paste.ini`` in a section titled ``[filter:healthcheck]``.
It should look like this::
[filter:healthcheck]
use = egg:oslo.middleware#healthcheck
Desired keystone application pipelines have been defined with this filter,
looking like so::
[pipeline:public_version_api]
pipeline = healthcheck cors sizelimit osprofiler url_normalize public_version_service
It's important that the healthcheck go to the front of the pipeline for the
most efficient checks.
For more information and configuration options for the middleware see For more information and configuration options for the middleware see
`oslo.middleware <https://docs.openstack.org/oslo.middleware/latest/reference/healthcheck_plugins.html>`_. `oslo.middleware <https://docs.openstack.org/oslo.middleware/latest/reference/healthcheck_plugins.html>`_.

4
doc/source/admin/identity-bootstrap.rst
View File

@ -78,6 +78,10 @@ both the user and the project will be created in the ``default`` domain. By not
creating an endpoint in the catalog users will need to provide endpoint creating an endpoint in the catalog users will need to provide endpoint
overrides to perform additional identity operations. overrides to perform additional identity operations.
This command will also create ``member`` and ``reader`` roles. The ``admin``
role implies the ``member`` role and ``member`` role implies the ``reader``
role.
By creating an ``admin`` user and an identity endpoint you may By creating an ``admin`` user and an identity endpoint you may
authenticate to keystone and perform identity operations like creating authenticate to keystone and perform identity operations like creating
additional services and endpoints using the ``admin`` user. This will preclude additional services and endpoints using the ``admin`` user. This will preclude