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
Now that most of the operator docs are consolidated into the admin
guide, it is huge and hard to find things. This patch breaks the guide
into groups to make it a little easier to navigate:
1. Getting started: basics of keystone and initializing a deployment.
2. Configuration: not a replacement for the main config docs but a
grouping of all discussions on the various config options.
3. Operations: maintenance workflows like upgrading and cleanups
4. Tokens: an important part of keystone
5. RBAC: gets a section to itself
6. Advanced keystone features: grouping of lesser-known/lesser-used,
not-required features.
7. Authentication mechanisms: various auth methods besides password,
including the federation guide
Change-Id: I9039b7023d843349154d28ee0ee2c7b9a9eb97ab
Move the identity sources support matrix to the administrator guide and
clean up the remainder of the configuration page and the operator guide.
Change-Id: If6978121873b6b4a5438164f082f359688477298
One of the community goals for Stein is to implement a command-line
tool for operators that runs programmable checks that might impact
upgradability.
This commit lays down the basic structure for the upgrade checks and
ties it up to `keystone-status` command.
Story: 2003657
Task: 26135
Change-Id: I6586827104156ac549217967a1b9171f1a3b32e4
With the docs migration and re-arrangement, some docs
have been shifted to new places, however the referenced
links are still old. Some of them give 404 error or
just point to the home page. This patch fixes those URLs.
Change-Id: Ie6b18ab3d4aa346dac8436dd426277fee4f07fcd
Added keystone-manage documentation from man pages
to the placeholder created for CLI Documentation.
Change-Id: I0e259c76d96c6479a6165c535bc49c032b2f41da
Added end user specific content from API documentation
to the placeholder created for User Documentation.
Change-Id: I8dbeeabb992a93b8b18df812da983bc6ca434cc5
The sample files were being rendered in two separate places. This
commit removes one of them and adjusts the references accordingly.
This commit also removes the sample files from the Operator guide
since they have their own dedicated section under configuration/.
Change-Id: I6da0843e2cb9dc7451d97af661a6cb4873eba671
The specification detailing the great documentation migration
requires a doc/source/cli/ directory be added to the project.
The directory is intended for cli 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 cli guide.
Change-Id: Ida5ffc979d3c596547e9664dce8933d2cf9a4486
Closes-Bug: 1694460
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
The specification detailing the great documentation migration
requires a doc/source/contributor/ directory for all contributor
documentation. Keystone had a directory specifically for this type
of content but it was in doc/source/devref/.
This commit renames devref/ to contributor/ because the term
`contributor` is more inclusive of other community members that
aren't necessarily developers. The specification also requires this
convention for consistency with other projects.
Change-Id: Id6363213dc6ba6946bd272ca5ee67b4604afc5ac
Partial-Bug: 1694460
The doc migration spec requires each sub directory
to have an index page which could be directly
referenced in the main openstack documentation under
the topic specific pages, along with other projects.
This patch validates that and adds new files where
they are absent.
Change-Id: I180952857db758482fd767aa9f5cf6343fec9c42
There are auto generated configuration and policy guides which
were earlier manually copied and referenced. Used sphinext
module in oslo_config and oslo_policy to automatically render
those pages.
Change-Id: I2b49eb0083661cce70c5b9457fe5bd32dfe5e5e8
Currently some of the config references docs are a part of
general OpenStack-manuals. Migrating those docs to keystone
documentation so that they can be reviewed effectively by
keystone developers too.
Following the specs, the files are added to admin/ and
configuration/ directories.
The files containing congiguration options are added
in a subsequent patch using oslo.config plugin.
Partial-Bug #1694460
Change-Id: I9a85f610e66a10dac54c50b2a54305e979888ee5
Our documentation previously had a statement saying it was primarily
geared towards contributing developers. This commit removes that
statement and replaces it with a more general one. Subsequent patches
are going to be migrating a bunch of useful information for
contributors, developers, and operators alike.
Change-Id: I8cea91b755f53265c21ec72b01939a7c646d3756
The API curl examples are not automatically generated
and can be outdated with time. Added a note in API
documentation as warning for this.
Change-Id: I3ac14dec1c04bf9d4092e045f21b463a8ee05fb3
Some docs present in developer documentation section
are related to APIs and API examples. Following the
reorganisation of docs in four categories, those docs
are migrated to the user/API doc section.
Change-Id: Id7f7b5601295036a54c6840015d0f0b4b2d23a21
Previously, the developer documentation in keystone was meant for
keystone developers. With keystone taking on more documentation
from the openstack-manuals repository, this commit renames developer
to contributor, since developer can also mean someone developing
applications on top of OpenStack. Let's keep the two separate for
now.
Change-Id: Id66747aa9e76bb62a801571551aa82119af98dfa
Currently some keystone installation guide docs are part of
general OpenStack-manuals. Migrating those docs to keystone
documentation so that they can be reviewed effectively by
keystone developers too.
Added installation guides for Ubuntu, openSUSE and
Red Hat Enterprise. The installation guides for Debian will
be added once they are complete in openstack-manuals.
Also changed the toctree structure in install-guides to
include directives so that all sections appear on one page
rather than just links.
Partial-Bug #1694460
Change-Id: I03aecfd1544b559a8fbd1ab11c5474145cff9ff9
Currently the identity administrator guide docs are a part of
general OpenStack-manuals. Migrating those docs to keystone
documentation so that they can be reviewed effectively by
keystone developers too.
Partial-Bug #1694460
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: Id121ae1dd5bce993b4ad1219b592527ef0047063
The keystone documentation has a super small statement about the
other projects the team supports, like keystoneauth and
keystonemiddleware. This was documented as its own section. This
commit moves it into the main document, just beneath the description
of the Identity Service.
Change-Id: I09e1177035dd31f07cdbc080d29510767d6d574e
Divided the keystone docs into four categories, depending
upon the usage criteria: general information (which will
be common for all), developer documentation,
user documantation and operator documentation.
Change-Id: I2f5dd41acd9874739accc54c4f4fd69460b58334
Since we're moving all policy into code and documenting it there we
should generate those docs automatically, so they are less likely to
be out-of-date.
Change-Id: If00cd3bcc654a45944c0bc8b3f146c75bd970f9a
partially-implements: blueprint policy-docs
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.
Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
- update the API link
- add a link to keystoneauth
- include a link to the docs source
Change-Id: Id1e5e00164c4ba152bbd9fff9ac39f309be8e5c3
Closes-Bug: 1648886
* remove online_schema_migration_examples since they overlap
with a section in the best practices doc
* move developer docs to doc/source/devref and rename where
appropriate
* moved content in developer.rst around, so the more often used
functions (releasenotes, docs, sample config and tests are
near the top).
* general clean up
Change-Id: If00b6535564644ff1f5b78e232edbac5d6e686f0
* We do not use extensions any longer, everything is core all
the time.
* keystonemiddleware has been a thing for a long time, lets
remove the doc that links back to it.
Change-Id: Id51f5d6f09c65a15908cb6e7964336ba680241d4
there is a lot of overlap between the two docs, let's have a
single doc instead.
also clean up the references to modules as they have bitrotted.
Change-Id: I05d30fa51052b875b1de94c4152036b1d0768793
The content from configuringservices belongs in the general
configuration guide. This results in one less file that can
branch off and overlap.
Change-Id: I0490818f862d982072c0adfaa1f02d7ac9c8abe3
* landing page: increase toc depth for configuration for easier navigation
* landing page: move keystone-manage man page to bottom
* created common keystone-manage commands doc, so config and man page can
reference
* moved the sample config files section up near config file section
* moved fernet token section up near token section
* moved token flush near token section
* moved endpoint policy and endpoint filter near catalog
* removed references to devstack files that do not exist
* removed references to experimental and stable status for stable features
* removed references to keystoneclient CLI
* removed IANA portions, not config related
* removed section about user CRUD on v2.0 API, not config related
* lots of minor cleanup with syntax and wording
Change-Id: Id814b70d626299ba0717d6759ec6be5e97645a39
Rolling upgrades are being introduced in the Newton release, which will
substantially impact the process that deployers will have to follow to
upgrade keystone.
This will provide us a basis for documenting rolling upgrades (also,
it's about time we documented our current process).
bp manage-migration
Change-Id: I5a37c781b83967b12cda60b054c612df3c3cb697
I made a few specific changes, hopefully for the better:
- Removed the "Welcome!" from the title, which is quite verbose in the
sidebar index (and reads awkwardly as a title, IMO).
- Revised the project description to match what's on our Launchpad page,
https://launchpad.net/keystone
- Revised the target audience to more accurately reflect who we actually
write for (it's still contributors first, but it's not fair to ignore
operators, etc).
Change-Id: I9955f31216e7a70fed10501f096001433609ac70
This change adds a tutorial for making an API change. It describes from
the specification proposal to making real code changes in keystone.
Its goal is to help new contributors to get familiar with keystone code.
It simulates the addition of a 'description' field to role entities.
Change-Id: Ie6f302939f43e78f07183abf4bc5aadb6b50ef1c
Eventlet has been deprecated since the Kilo release and is
being removed in Newton.
A follow on patch will be proposed to remove the [ssl] section
since it is now redundant.
Co-Authored-By: Grzegorz Grasza <grzegorz.grasza@intel.com>
Partially implements: bp removed-as-of-newton
Change-Id: I963d94bbd188dbb6eba68623a42c5bc3f2289da4
several of the federated identity docs were spread out in hard
to find locations. this puts the documentation more front and
centrer. expect detailed changes for each docs in future patches.
Change-Id: I82ba117dfd02f921d72b9f010becad57da03e090
the `getting started` section had fairly advanced topics, and the
developer docs had info that should be user facing.
Change-Id: Id2f619140869769de29ddfa14ab168cc696be933
python-keystoneclient CLI was removed in patch #258181.
This patch updates removes file that had examples of
keystone CLI usage.
Change-Id: Ie7d3624149f15ee806aee3db4f64f542414b4728
Support TOTP as a distinct authentication mechanism from Password.
bp totp-auth
Co-Authored-By: David Stanek <dstanek@dstanek.com>
Change-Id: Ic0ccf89b9f35d3167a413b10f43be43cf892aead
Andreas Jaeger