Commit Graph

15 Commits

Author SHA1 Message Date
Marcin Wilk 3856cbf10d Add service_type config info for access rules
The service_type config param is crucial to successfully use
application credentials with access rules.

Closes-Bug: #1950464
Change-Id: I98d1cfcbd229f2939d900861f453efa996466c32
2022-04-25 07:57:30 +00:00
Colleen Murphy 58790d9dc1 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
2019-12-17 08:33:42 +00:00
Colleen Murphy 8c58b5b75e Fix application credential doc example
In 532452f7 we converted the application credential examples to use
python-openstackclient instead of python-keystoneclient, but forgot to
update the prose to go along with it. Correct the client name now.

Change-Id: I6795e42ffc1e9134beedd5fa78d079dba4c5ef42
2019-12-04 13:18:07 -08:00
Andreas Jaeger f10f95b455 Docs: Make robust with using real links
Our tools noticed that keystone links to
https://docs.openstack.org/keystone/latest/admin/identity-domain-specific-config.html
which does not exist anymore.

The page was removed but the link to it was not changed. Replace this
and similar links with internal links that will work even if files are
moved - and can be verified, thus sphinx will error in case of broken
targets.

These changes include a few other fixes for broken keystone links, e.g.
to renamed anchors.

For the include files in admin/configuration.rst and
admin/federation/configure_federation.rst: Rename them to *inc.
The files were
published twice (as separate files and on this page) and thus
referencing failed. Renaming avoids this.

Also, put doctree outside of html tree so that it does not get
published.

Change-Id: I3d07637b0046cc88a66bcb51a0a4fe7c146c1549
2019-08-09 20:15:14 +02:00
Andreas Jaeger 23b0011535 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

This does not relationship URIs since "these links do not resolve to
anything valid, but exist to show a relationship."

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: I6efdf375bc8e1e5ca2b113337002d6178180a1e1
2019-07-23 06:53:33 +02:00
Colleen Murphy 81c3202b43 Add note about application credential ownership
Some people are still disappointed by the fact that application
credentials are not project-owned. This patch adds a note about why this
decision was made and adds a recommendation to overcome it.

Change-Id: I546bdc55937948d51154f4a4aecec08b4e4fd58d
2019-05-28 15:04:25 -07:00
Adrian Turjak 6564b40641 Add documentation for Auth Receipts and MFA
Adds API ref examples for TOTP and Auth receipts.

Adds docs for MFA and changes some of the user options
docs.

Change-Id: Id5497064e580093e4a2c7d904670a58095833b3b
2019-01-22 15:36:06 +13:00
Colleen Murphy 79165aa469 Split trusts docs between admin and user guide
Trusts are user-facing, so explaining how they work should be in the
user guide. Cleaning up expired trusts is still an administrative task,
so leave that in the admin guide.

Change-Id: I9a77efd3c93c9b5b504c8143a51fb08b50139119
2018-12-12 11:17:04 +01:00
Colleen Murphy 0b29be3302 Move supported clients section to user guide
Additionally, correct examples to use proper v3-style credentials.

Change-Id: Ie64a691a12175ca74a5ac7ea90217f68607beb06
2018-12-10 16:53:02 +01:00
Zuul 225a16fb83 Merge "Use OSC in application credential documentation" 2018-03-16 12:00:33 +00:00
Lance Bragstad 3bde2447bb Add user documentation for JSON Home
Keystone has supported JSON Home documents since Juno, but we never
had any user-facing documentation for the API. This commit adds a
section to the user guide that describes what JSON Home is and adds
an example of how users can get it.

Change-Id: Ib0793f6af4f65e5549ba0543b87d20f3f1a8a62d
2018-03-07 22:21:25 +00:00
Colleen Murphy 532452f74e Use OSC in application credential documentation
With support for application credentials landed on
python-openstackclient, update the documentation to use this more
user-friendly method of managing application credentials.

Change-Id: I0c05d5a276a6aeb6cc464420ca8c529ed00e4b45
Depends-on: https://review.openstack.org/536163
2018-02-14 20:33:57 +01:00
Colleen Murphy 25996a8534 Add docs for application credentials
Add documentation in the User section on managing, using, and rotating
application credentials.

Since application credential support didn't make it into
python-openstackclient in the Queens release, show examples using
python-keystoneclient.

Change-Id: I24bc51d2f3741771ba321fc05d49fd111aa76c15
2018-02-14 20:33:48 +01:00
Samriddhi Jain e925160634 Fill in content in User Documentation
Added end user specific content from API documentation
to the placeholder created for User Documentation.

Change-Id: I8dbeeabb992a93b8b18df812da983bc6ca434cc5
2017-08-04 22:55:27 +05:30
Lance Bragstad 900a00e4b4 Add user/ directory for documentation
The specification detailing the great documentation migration
requires a doc/source/user/ directory be added to the project.
The directory is intended for end user documentation.

This commit add the directory so that we are in compliance with the
specification but doesn't move any content into the directory. It is
instead treated like a placeholder until we can migrate the right
content into the user guide.

Change-Id: I7d9cde958957bff20c7221f37cb0b03b61aa38f9
Partial-Bug: 1694460
2017-08-01 21:44:10 +00:00