Commit Graph

999 Commits

Author SHA1 Message Date
Jenkins
9cbd6bc0eb Merge "Remove duplicate sample files" 2017-08-04 19:58:01 +00:00
Lance Bragstad
9e5a6d6750 Remove duplicate sample files
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
2017-08-04 14:08:48 +00:00
Lance Bragstad
77bf1ad0b8 Remove policy for self-service password changes
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
2017-08-04 13:56:59 +00:00
Doug Hellmann
fffc84db79 use the show-policy directive to show policy settings
Closes-Bug: 1707246

Depends-On: I774b2de5ff59874dfa67811c094735dd74c8083e
Depends-On: Ie836b7a6f3ea7cba1737913b944f36c77f14cfd0
Change-Id: I5ce0931d39b045681ba6d43d7894ae25e6b13146
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-08-03 13:58:49 +00:00
Jenkins
0cbd421da6 Merge "Remove duplicate configuration sections" 2017-08-03 02:15:12 +00:00
Jenkins
bba90f6157 Merge "Clarify documentation on whitelists and blacklists" 2017-08-03 00:18:27 +00:00
Jenkins
9f03a88fdf Merge "Consolidate LDAP documentation into admin-guide" 2017-08-02 16:58:33 +00:00
Lance Bragstad
c1e9c97d33 Consolidate LDAP documentation into admin-guide
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
2017-08-02 13:55:41 +00:00
Lance Bragstad
bd5edb6247 Add cli/ directory for documentation
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
2017-08-01 21:47:32 +00:00
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
Lance Bragstad
429e115686 Add contributor/ directory for docs
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
2017-08-01 21:14:46 +00:00
zhiguo.li
b9c0252a4c Add the step to install apache2 libapache2-mod-wsgi
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
2017-07-28 19:28:58 +08:00
Lance Bragstad
0331a11842 Clarify documentation on whitelists and blacklists
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
2017-07-26 20:48:19 +00:00
Jenkins
2c9d3eb674 Merge "Move performance documentation to admin-guide" 2017-07-26 18:04:33 +00:00
Jenkins
995e013e16 Merge "Added new subsections to developer docs" 2017-07-26 17:58:19 +00:00
Lance Bragstad
b614a0ce8a Move performance documentation to admin-guide
Now that the admin-guide lives within keystone, it should be home to
our performance documentation.

Change-Id: I522cf238a977e9cead384fcf993300e7f8c2a395
2017-07-26 14:59:24 +00:00
Jenkins
c44a9eaaeb Merge "Move auth plugin development doc to contrib guide" 2017-07-25 19:57:53 +00:00
Lance Bragstad
e2ebb3c41a Move auth plugin development doc to contrib guide
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
2017-07-25 14:58:39 +00:00
Jenkins
bd3c5e50e0 Merge "Added index.rst in each sub-directory" 2017-07-25 02:08:35 +00:00
Jenkins
7c3acf34fa Merge "Enable sphinx todo extension" 2017-07-24 16:00:45 +00:00
Samriddhi Jain
7dbbe60512 Added new subsections to developer docs
Merged the basic docs, keystone architecture and
external developers related docs to create separate
sections for the three.

Change-Id: I23b4ac709e0040e5580c451f4c7f54dc194a5529
2017-07-23 00:40:29 -10:00
Samriddhi Jain
da5c9d7bd4 Added index.rst in each sub-directory
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
2017-07-20 22:24:22 +08:00
Lance Bragstad
0c55bae655 Move development environment setup to contributor docs
The development environment setup docs were duplicated in two
separate places. This commit remove it from the "Getting Started"
section and into the contributor guide.

Change-Id: If243fd9896be286f9d4c80139eb3cb86600f0052
2017-07-18 16:31:00 +00:00
Jenkins
9d0b12f64f Merge "Reorganised developer documentation" 2017-07-18 11:44:48 +00:00
Jenkins
0e1b9cc22b Merge "Expanded the best practices subsection in devdocs" 2017-07-18 11:43:25 +00:00
Jenkins
5a9be6e00e Merge "Merged the caching subsections in admin docs" 2017-07-18 11:39:28 +00:00
Jenkins
c2296adb8e Merge "Added new docs to admin section" 2017-07-17 21:33:06 +00:00
Samriddhi Jain
a764b90f74 Reorganised developer documentation
For a better readability and flow, reorganised and
renamed various sections in developer documentation.

Change-Id: I23ac014701e0ca0984e23ff07192cfdf4d8fd4dd
2017-07-18 00:14:41 +05:30
Jenkins
cca14dd884 Merge "Update info about logging in admin guide" 2017-07-17 16:41:11 +00:00
Gage Hugo
bc18bbbc5f Enable sphinx todo extension
In a previous change [0] when warning-is-error was
added, the sphinx todo extension was causing errors
with duplicate registration.

However with the recent changes between pbr and
sphinx, this extension no longer throws a duplicate
error when using warning-is-error and we can add
it back in.

[0] https://review.openstack.org/#/c/439674/

Change-Id: Ie28d87dfca8ee5cbea28616b32c471d848c50759
2017-07-17 11:03:29 -05:00
Lance Bragstad
2c6458c355 Remove duplicate configuration sections
Keystone nows has it's own configuration guide, which means we no
longer need to maintain a separate configuration reference in the
operator guide.

Change-Id: Iadfb90db9f5f23798d57a442e372d35519332a49
2017-07-17 15:04:28 +00:00
Samriddhi Jain
196fd88c4a Expanded the best practices subsection in devdocs
As a part of reorganisation of developer docs, removed the
best practices documentation and made the subsections in it
as overall sections. More renaming and reorganisation will
be addressed in the following patches.

Change-Id: I21bf8fe3855fd1d441ec3dba342babc90516714d
2017-07-17 12:28:16 +05:30
Samriddhi Jain
dcc9d5ce28 Added new docs to admin section
Apart from the project related docs, these two docs
also need to be added as per the specs.
Change-Id: I81e536a7394ec6935434da296f99686d407e1608
2017-07-17 11:48:42 +05:30
Jenkins
33b0ec1397 Merge "Move bootstrapping documentation to admin-guide" 2017-07-16 10:33:49 +00:00
Jenkins
52bebba3e7 Merge "[install] Clarify the paths of the rc files" 2017-07-15 23:24:54 +00:00
Lance Bragstad
a393792028 Move bootstrapping documentation to admin-guide
The operator documentation had two sections that described
bootstrapping keystone. This is better suited for the admin-guide
and this commit moves it there.

Change-Id: Ibca2bc3e439ca6e26d8e4ead13ed101fd9010f12
2017-07-15 20:04:57 +00:00
Jenkins
a43d5a6893 Merge "Move trust to DocumentedRuleDefault" 2017-07-13 01:15:17 +00:00
Jenkins
7e6eca7929 Merge "Replaced policy.json with policy.yaml" 2017-07-13 01:10:02 +00:00
Samriddhi Jain
4bbc505e71 Merged the caching subsections in admin docs
Currently there are two subsections named caching layer in
the admin docs. This commit merges the information in the
two and removes the duplicate docs.

Change-Id: I0f8a89c0eccc2ad6078b4d21dae274df3fc9da18
2017-07-12 20:53:33 +05:30
Anthony Washington
8f09c9cf0b Move trust to DocumentedRuleDefault
A new policy class was introduced that requires
additional parameters when defining policy objects.

This patch switches our trust policy object to
the policy.DocumentedRuleDefault and fills the
required policy parameters as needed.

Implements: bp policy-docs

Change-Id: I7d4bab14ff257ede59a1b49088e16842e5b59a64
2017-07-12 11:09:51 +00:00
Samriddhi Jain
57e06bd1e9 Improved the keystone federation image
The image migrated as a part of openstack-manuals is
a little pixelated and blurred. This commit replaces
the image with a higher resolution one.

Also a .svg version of this file is updated. The file
is not used as such in the docs but is useful if
someone wants to make changes to the png image, which
can be generated from the .svg file.

Change-Id: I56b863974adb5642f47e7561aa70bc582c85485f
2017-07-12 13:31:54 +05:30
Jenkins
9b3d99ea24 Merge "fix identity:get_identity_providers typo" 2017-07-12 05:56:00 +00:00
wingwj
0a90e39cad [install] Clarify the paths of the rc files
Add explicit statement about the rc files' paths
in the installation guide.

Change-Id: Ib652a231ce0c1760630119aa34aa30106d26a20d
Closes-Bug: #1696264
2017-07-12 13:55:59 +08:00
Jenkins
f18c699be9 Merge "Added configuration options using oslo.config" 2017-07-12 00:28:52 +00:00
Jenkins
445d53023c Merge "Added configuration references to documentation" 2017-07-12 00:28:05 +00:00
Matthew Edmonds
b7119637a0 fix identity:get_identity_providers typo
Changes identity:get_identity_providers policy rule to
identity:get_identity_provider to match what is checked by the code.

Change-Id: I0841abd30fd15c034b5836e42a18938634b509b1
Closes-Bug: #1703369
2017-07-11 17:51:57 -04:00
Jenkins
0731dab01a Merge "Move upgrade documentation to admin-guide" 2017-07-11 13:35:25 +00:00
Jenkins
2c67130fe0 Merge "Move caching docs into admin-guide" 2017-07-11 06:15:39 +00:00
Samriddhi Jain
e4c629ad0d Replaced policy.json with policy.yaml
The config files included from openstack manuals refer
to policy.json sample configuration file. Currently policy.yaml
is being used as the sample file in keystone.
To avoid any confusion, this commit replaces instances of
policy.json with policy.yaml.

Change-Id: Ib2d4496fa90639b2ed9b72d1f03354a0c0beffd2
2017-07-10 18:45:25 +05:30
Samriddhi Jain
718a046447 Added configuration options using oslo.config
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
2017-07-10 17:34:21 +05:30