This isn't actually used and is a leftover from a thing we did
seven years ago that survives today through copy-pasta.
Change-Id: I965ea16d39072dbf54a0d8d8718422efe9cff457
This change breaks the get-started-identity, keystone-users,
and keystone-openrc pages into multiple copies for each distribution
release in the keystone install guides. Before this change, sphinx
would not render the links correctly and these pages would be skipped
in both the RDO and Ubuntu guides.
To avoid unneccessary duplication of the same text, the files were
moved into common/ and are simply included into the newly created
files for each release.
Change-Id: I7b478504f1e68034ea993c0214705045da86bb6e
Closes-Bug: #1712335
This was discussed in today's keystone meeting. It was decided that
there should be some more clarification around release notes and how
to update them.
Change-Id: I4a06fda76dc8589a755438ccc12bc0bf2f575dcb
Two reasons for adding this step:
1. The title of this chapter named “Create a domain, projects, users,
and roles”，but there is no step to introduce how to create a
domain.
2. Explain to users where the domain 'default' comes from because the
default domain is used in later steps.
Change-Id: I5b627ce15f94f18fd538866a32b84e540090bfff
Closes-Bug: 1707130
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
In order for a federated user to be mapped to a local user that exists
in the identity backend, the user object in the local mapping rule must
have the property "type": "local" set, in addition to having a keystone
domain provided. This was probably not the original intention of the
local user mapping spec[1], but this is how it ended up being
implemented. We could choose to change the behavior of the code, but
it has been around long enough that it is possible that deployments are
depending on this behavior, and moreover making rules explicit rather
than implicit reduces the risk of bugs and mistakes.
This patch updates the api-ref documentation and the standard federation
documentation to include the "type" property when mapping to local
users. In addition, since we now have two keywords called "local" that
mean somewhat different things, we expand the context of some of the
mapping examples so that both the rule name "local" and the value
"local" of the attribute "type" appear in the example, for clarity.
Change-Id: Ib35e57e33903de14f9cac1f919c32dfe923ef884
Closes-bug: #1673157
Since Sphinx 1.6 released, pbr's build_sphinx extension has been broken.
Specifically, pbr's [build_sphinx]/builders option is ignored. Luckily,
sphinx itself ipmlemented the feature but called it just 'builder'[1].
This patch fixes the config setting name and then cleans up a Sphinx
extension inclusion that is now automatically included.
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-July/119396.html
Change-Id: I5da6a996ed442524ddb108a890df2d024ee07c4d
Added end user specific content from API documentation
to the placeholder created for User Documentation.
Change-Id: I8dbeeabb992a93b8b18df812da983bc6ca434cc5
The eye-catchy-ness of the Important SELinux notice in the LDAP
integration documentation can cause confusion for users to whom the
notice is not applicable, such as Ubuntu or SUSE users. For them,
SELinux is not enabled by default and they may not even be aware of what
it is for, and so perceive a failure when they try to enable the SELinux
boolean as described in the document. This patch prepends a
clarification that the notice only applies to SELinux users, to
hopefully make it clearer that not being able to follow the directions
is just fine in many cases.
Change-Id: I65a34608f1a51ec923329065b6443bdd525a1ac7
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 self-service password API was left intentionally
unprotected in a change during the stable/ocata cycle:
I4d3421c56642cfdbb25cb33b3aaaacbac4c64dd1
The default policy was not removed from the same config and as a
result it was migrated into code during the policy-in-code work.
This isn't necessary since it's not used to protect anything. Policy
should still be enforced on administrative password resets, but that
is done using the `update_user` API.
Change-Id: I431f5ef9d6d5d689a06736640d22997fbddb869c
Closes-Bug: 1705485
This is part of an effort to consolidate all the content in the
Operator guide into the Administrator guide.
Change-Id: I3431ecbff399bf6ae7620996e4c4cce9bb3489eb
This commit merges two documents that were both attempting to
document integrating keystone with LDAP. Instead, we should have a
single document so that it's easier to operators to understand and
find.
Change-Id: I1b1927b498d93f39d57a03b60384de22f07ad2f2
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
This is part of an effort to consolidate everything from the Operator
guide into the Administrator guide.
Change-Id: I76b0eaee11f5a8d68304a163381c905611edd43b
The guide uses the Apache HTTP server with mod_wsgi to serve
identity service, but it did not introduce the step to install
Apache2 and libapache2-mod-wsgi package in this guide. The identity
service will not be started without these two packages.
This patch modify the step 1 in part "Install and configure components"
for installing two packages metioned above.
Change-Id: I8ca55e605f806bdc48f753ab893040d9a76aa93d
Closes-Bug: 1707176
Some references to whitelisting and blacklisting was confusing in the
mapping documentation. This commit attempts to clarify the wording
and purpose for both whitelists and blacklists.
Change-Id: I09f4762f03824acc689600c8561fe99ea113ad9a
Closes-Bug: 1693690
Now that the admin-guide lives within keystone, it should be home to
our performance documentation.
Change-Id: I522cf238a977e9cead384fcf993300e7f8c2a395
The admin-guide and configuration.rst both had separate sections
that detailed certificate documentation. Much of the documentation
was exactly the same. Now that keystone owns it's own admin-guide,
we can remove the duplication and simplify our docs.
Change-Id: I387902723637174c259ff421083a2933942f07fd
The operator documentation had a section specific to developing
authentication plugins. This type of documentation is better suited
to the contributor guide. This commit moves it there.
Change-Id: I74337e8b3d8c9031fa3cb7fb709cc41042161bb9
Merged the basic docs, keystone architecture and
external developers related docs to create separate
sections for the three.
Change-Id: I23b4ac709e0040e5580c451f4c7f54dc194a5529
