Browse Source

Add docs for app cred access rules

We had documentation in the API reference but not in the user guide. Add
information about creating and managing access rules to the user guide
to make it more user-friendly.

Change-Id: Iaa66c8220e65083551daf727b52226da5cce5313
Depends-on: https://review.opendev.org/677857
changes/75/697375/4
Colleen Murphy 2 years ago
committed by wangxiyuan
parent
commit
58790d9dc1
  1. 86
      doc/source/user/application_credentials.rst

86
doc/source/user/application_credentials.rst

@ -120,6 +120,9 @@ invalidate the user's application credentials for that project.
| unrestricted | False |
+--------------+----------------------------------------------------------------------------------------+
An alternative way to limit the application credential's privileges is to use
:ref:`access_rules`.
You can provide an expiration date for application credentials:
.. code-block:: console
@ -165,6 +168,89 @@ involved, you can disable this protection:
| unrestricted | True |
+--------------+----------------------------------------------------------------------------------------+
.. _access_rules:
Access Rules
============
In addition to delegating a subset of roles to an application credential, you
may also delegate more fine-grained access control by using access rules. For
example, to create an application credential that is constricted to creating
servers in nova, the user can add the following access rules:
.. code-block:: console
openstack application credential create scaler-upper --access-rules '[
{
"path": "/v2.1/servers",
"method": "POST",
"service": "compute"
}
]'
The ``"path"`` attribute of application credential access rules uses a wildcard
syntax to make it more flexible. For example, to create an application
credential that is constricted to listing server IP addresses, you could use
either of the following access rules:
::
[
{
"path": "/v2.1/servers/*/ips",
"method": "GET",
"service": "compute"
}
]
or equivalently:
::
[
{
"path": "/v2.1/servers/{server_id}/ips",
"method": "GET",
"service": "compute"
}
]
In both cases, a request path containing any server ID will match the access
rule. For even more flexibility, the recursive wildcard ``**`` indicates that
request paths containing any number of ``/`` will be matched. For example:
::
[
{
"path": "/v2.1/**",
"method": "GET",
"service": "compute"
}
]
will match any nova API for version 2.1.
An access rule created for one application credential can be re-used by
providing its ID to another application credential. You can list existing access
rules:
.. code-block:: console
$ openstack access rule list
+--------+---------+--------+---------------+
| ID | Service | Method | Path |
+--------+---------+--------+---------------+
| abcdef | compute | POST | /v2.1/servers |
+--------+---------+--------+---------------+
and create an application credential using that rule:
.. code-block:: console
$ openstack application credential create scaler-upper-02 \
--access-rules '[{"id": "abcdef"}]'
Using Application Credentials
=============================

Loading…
Cancel
Save