1154 Commits

Author SHA1 Message Date
chenxing
0df5bb0d0c Update RDO install guide for v3
This is a supplement for https://review.openstack.org/556023

Change-Id: I20f698a0d820f4e99cea110f157f6ba53423bce5
Closes-Bug: #1790148
2018-09-03 16:59:13 +08:00
Gage Hugo
c41dc6f036 Add details and clarify examples on casing
This change adds some more detail to the roles section of the
casing documentation for keystone, as well as clarifying the
examples given for users and projects. Also added project tags
casing.

Change-Id: I55447c8b599ab48021bd95204c4bf3c5bc7e690c
2018-08-27 17:11:40 -05:00
Colleen Murphy
22c22f2005 Use osc in k2k example
python-openstackclient now has proper support for a keystone-to-keystone
session, so document that instead of falling back to keystoneauth.

Change-Id: I3d78ea085b9cabc50681e5f878172a5efe3e7c43
2018-08-14 10:29:10 +02:00
Gage Hugo
4988bca4e4 Fix json indentation of notification sample
This change fixes the indentation of some of the fields in
the notification example of "Expired Password".

Change-Id: Icf67e4ab4eac0769c09db91d7017a3a067eaf684
2018-08-02 21:59:41 -05:00
wangxiyuan
203787c37f Clean up token extra code
Originally, the "extra" in token data is generated by auth plugin
and then will be return to users within token data.

In Kilo, the "extra" in token data was deprecated[1], after that
if the auth plugin generate the "extra", a warning log will be
raised. To stop the warning, the auth plugins should stop
generating "extra" field.

After two releases, in Mitaka, the "extra" in token data was
removed[2], but the "extra" was still created by default as an
empty dict {}. Actually, "extra" should not be created any more
in Mitaka because Keystone has warned the auth plugins for two
releases.

Now in Rocky, it's safe enough to remove the "extra" from token
issue flow at all since it has never been used from Mitaka. The
only concern for the out tree plugins about the removal is that
if they still put "extra" into auth_context, Keystone will raise
KeyError. But can it be happened? Only if the out tree plugins
ignore the warning in Kilo, and still contain "extra" but never
use them from Mitaka. For most auth plugins which follow the
Keystone deprecation step, this patch is a silent change.

[1]: https://review.openstack.org/#/c/162662
[2]: https://review.openstack.org/#/c/249480

Change-Id: I828cc0ad3ac265abdfea2e1571806add128ae51e
2018-08-02 11:52:10 +08:00
Martin Chacon Piza
a272b66181 Adding missing comma in docs
Change-Id: Icf3b2699429adf16fbd0b3657ebdf17b973432bf
2018-07-30 14:37:19 +02:00
Zuul
31bc693001 Merge "Add docs for case-insensitivity in keystone" 2018-07-25 21:04:33 +00:00
Zuul
199e9b5238 Merge "Switch to python-ldap" 2018-07-18 17:44:25 +00:00
Dirk Mueller
0fa6f97891 Switch to python-ldap
pyldap is deprecated and merged with python-ldap, so we should depend
on it directly instead of the deprecated wrapper. For details see
https://pypi.org/project/pyldap/

Change-Id: I2c8ee2c792a476fe12c234a55af24144e6b511cd
Depends-On: https://review.openstack.org/#/c/582973/
2018-07-16 17:33:38 +02:00
Tuan Do Anh
b039ad331f Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I49a5d6d83a1384698fce36b416e343b038aad87b
2018-07-12 14:54:47 +07:00
Gage Hugo
22af20b0f6 Add docs for case-insensitivity in keystone
This adds a new page of documentation to describe how keystone handles
case sensitivity (or the lack of) depending on the resource and
backend used.

Change-Id: I868b43e6be7809648f9260e1b272f5626b30a95d
2018-07-10 20:29:21 +00:00
Gergely Csatari
8c188d47f7 Clarifications to API & Scenario Tests
Installation of tempest itself and the installation of the
keystone-tempest-plugin is missing from the description.
This change adds them.

Change-Id: I76c4199429b9bffc606928fb32fe87805b7eac24
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
2018-07-09 14:58:20 +02:00
Zuul
5621786f75 Merge "Simple usage docs for implied roles" 2018-06-29 13:17:09 +00:00
Colleen Murphy
e2e561f810 Add new "How Can I Help?" contributor guide
We see a lot of very small patches from new contributors to do things
like fix typos, correct grammar, switch to HTTPS URLs, and similar
trivial changes. Many of these changes are technically correct, but the
value they provide to the project is very low. Assuming the best of
intentions, the obvious conclusion is that these contributors very much
want to help, but don't know where to start and haven't been given
proper guidance.

This patch introduces a new guide that lists some ongoing tasks that we
always want help with. These should be tasks that someone with no
historical context in the keystone project should be able to pick up,
but by starting a few steps above typo fixes will be able to learn
enough to eventually make more significant contributions. When typo fix
patches come in, we can use this guide to gently encourage new people to
make more valuable contributions.

Change-Id: I2a003bbef3ffbde1818fddcb840905eac6f0618c
2018-06-28 16:00:24 +02:00
Kristi Nikolla
d054c9a5ac Simple usage docs for implied roles
Depends-On: I08f785dc9e840da2e16915683eecfe49189c44b3
Change-Id: I47722a52f590eae1d1b5c6c5ac7f08b5508e9437
Partial-Bug: #1775094
2018-06-21 15:46:51 -04:00
Lance Bragstad
0022adb6ae Add policy for limit model protection
We plan to expose the enforcement model a deployment is using via
the limit API. This commit prepares for that implementation by
introducing the policy for it.

Change-Id: I03c9cec3646ee354ebcdd4ddc1168e00d611171b
Related-Bug: 1765193
2018-06-19 20:27:00 +08:00
Zuul
70b0b91e6c Merge "Unified limit update APIs Refactor" 2018-06-19 01:34:47 +00:00
David Rabel
4ff650fa26 Clarify complicated sentence in docs
Clarify complicated sentence in 
doc/source/getting-started/architecture.rst

Change-Id: I8ed5f39d9c2f388c1503b9f61f2fe980a7b7f0f1
2018-06-15 14:21:54 +00:00
wangxiyuan
b385864c5d Unified limit update APIs Refactor
According to the API-WG's suggestion, the update registered
limit/project limit APIs should be refactored as:
1. Change PUT to PATCH
2. Remove batch update limits support for PATCH

Closes-Bug: #1754184
Change-Id: I1102166ab425a55d8eaf85c75d8fd3a7dfbaceb6
2018-06-15 09:05:35 +08:00
Morgan Fainberg
8bf335bb01 Remove pastedeploy
This patchset removes the lingering code that supported paste.deploy
that is obsolted by the loader wrapped around keystone's use of Flask.

 * The keystone-paste.ini file has been removed.

 * All options have been removed (without deprecation) as they are no
   longer referenced.

 * The TokenAuthMiddleware code (with deprecation warning) has been
   removed as it was only provided to ensure compatibility with paste.ini
   files that were not updated (ensuring not breaking a deployer that
   did not update paste.ini file to remove it from the pipeline).

 * Paste deploy entrypoints have been removed.

Change-Id: I35064a440ef718f50c7e644e8b2d56a99c3ec74f
2018-06-06 19:30:26 +00:00
wangxiyuan
488ecef329 Fix warnings in documentation
A recent change defaults the warning-as-error to True:

  https://review.openstack.org/#/c/559348/

Which is causing our documentation jobs to fail locally and in the
gate/check queues.

This commit fixes both issues that are causing failures so that
we can get the doc jobs passing again.

Closes-Bug: 1774508
Change-Id: Ic1eff48a6f40aa315cc5e566a0f9e930a20b9837
2018-05-31 21:28:41 +00:00
Zuul
7671be8518 Merge "Add conceptual overview of the service catalog" 2018-05-16 16:45:41 +00:00
Suramya Shah
6bac0a1bae Consolidate oauth1.rst
Consolidate from configuration.rst into oauth1.rst.

Change-Id: I866e147935e5847a2feb66d61d45ef4241eb38cd
2018-05-11 15:09:01 -05:00
Suramya Shah
641694ce19 Consolidate health-check-middleware.rst
Consolidate from configuration.rst into admin/health-check-middleware.rst.

Change-Id: Ib4de0a26975641ae6bc44a4525423628a2a04a3c
2018-05-08 17:27:41 -05:00
zhang.lei
1a4a8db7d8 Fix the outdated URL
Change-Id: I0c3b755aee0b77cae0d13b03cc00475bf4e8706d
2018-04-27 08:27:25 +00:00
David Rabel
03c06a8125 Remove policy service from architecture.rst
- the policy service was never finished
- it's overall design doesn't contribute to the architecture of keystone
- it's mostly boilerplate code
- it's marked as deprecated in the API reference
- people trying to understand the architecture document don't need to
 fill a register with this information when there are other more
 meaningful things to parse

Change-Id: Ie4f5b992e277eb79041fd6211a171ca90057fd69
2018-04-25 15:06:57 +00:00
Dolph Mathews
856b240f9e Add conceptual overview of the service catalog
During the Liberty summit in Vancouver, there was a session on
the standardization of the service catalog:

  https://etherpad.openstack.org/p/service-catalog-cross-project-vancouver

As a result, Dolph put together a really good post condensing that
information for client developers as well as developers working
on integrating their services into the OpenStack ecosystem:

  https://blog.dolphm.com/openstack-keystone-service-catalog/

This commit massages some of the wording and proposes the guide as a
section of our own contributor documentation.

Co-Authored-By: Lance Bragstad <lbragstad@gmail.com>

Change-Id: Ie3328a8f7e093e894903a48809761fcbad279154
Closes-Bug: 1459402
2018-04-24 20:26:39 +00:00
Zuul
c3810678d8 Merge "Update auth_uri option to www_authenticate_uri" 2018-04-23 16:10:51 +00:00
Tovin Seven
1a5877f2ad Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I3a389a2e03c09363494bd6a919804152391a17b8
2018-04-20 16:55:41 +07:00
Zuul
7388889bce Merge "Update the RDO installation guide to use port 5000" 2018-04-20 05:20:43 +00:00
Zuul
11e524987d Merge "Allow blocking users from self-service password change" 2018-04-20 01:57:53 +00:00
Lance Bragstad
38d25b7b5f Update the RDO installation guide to use port 5000
This makes the RDO guide consistent with the Ubuntu and SLES guides.

Change-Id: Ic935e5335378246b3363f7fd96e958388aa98b50
2018-04-19 19:58:34 +00:00
Morgan Fainberg
f17fa57f6c Allow blocking users from self-service password change
User option ``lock_password`` has been implemented. This
option when set to ``True`` will prevent the usage of the
self-service password change API. If the ``lock_password``
option is set to ``False`` or ``None`` (to remove the
option from the user-data structure) normal password
change operations are allowed

Closes-Bug: #1755874
Change-Id: Icf1776c5fe625c2e9292bfcf40a8a9f17a002656
2018-04-18 19:15:07 +00:00
Zuul
e473cab853 Merge "Add prerequisite package note to Keystone install guide" 2018-04-18 17:18:25 +00:00
Russell Tweed
f01edae95c Add prerequisite package note to Keystone install guide
Added prerequisite package note and associated link to the main Install Guide
to the Keystone install guide. This is to ensure commands further down the
Keystone guide don't fail unexpectedly.

Change-Id: I189854fbc7f1e05945ab0002c08ee84f7bfad196
Closes-Bug: 1754413
Closes-Bug: 1754417
2018-04-18 14:38:16 +01:00
melissaml
22fa4e8176 Update auth_uri option to www_authenticate_uri
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: Iefad7ba17f01d2982567e7f1f207ecb29d093e83
2018-04-18 21:29:07 +08:00
Zuul
56237b709e Merge "Corrects spelling of MacOS" 2018-04-12 21:02:55 +00:00
jessegler
a5edf02521 Corrects spelling of MacOS
Change-Id: I396b919b01f93cd459bd10d937991fa37c53b479
Closes-Bug: 1762633
2018-04-12 10:38:46 -05:00
Nguyen Hai
a04a1dc782 Follow the new PTI for document build
- Follow new PTI for docs build
- Add sphinxcontrib.apidoc to replace pbr autodoc

REF:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Depends-On: https://review.openstack.org/#/c/559334/
Change-Id: I1d5f01cf49f36567f5a891c69c7269d3e966b9c5
2018-04-09 01:13:58 +09:00
Zuul
dc3de34027 Merge "Update install guides" 2018-04-04 18:34:25 +00:00
Harry Rybacki
4d313b72dd Update install guides
- Ensure myproject and myuser are used throughout the guide
consistently
- Add note that connection's host in keystone.conf must be resolveable

Change-Id: Icaaf6c1b7583ed75b7a6204d7fb1f3506e4e8937
2018-04-04 11:43:32 -04:00
Gage Hugo
69f0e553e0 Fix mispelling of accommodate in install docs
This change fixes the 3 occurrences of "accommodate" being misspelled
in the keystone install documentation.

Change-Id: I2eb50fd1aedb8e7cb7530d640aaa8f183134945c
2018-04-04 10:15:13 -05:00
Colleen Murphy
27762c8220 Update RDO install guide for v3
Bring the RDO install guide into alignment with the Ubuntu and SUSE
guides by removing references to the admin port 35357 that was used for
the keystone v2 API.

Change-Id: Ic2c5452dae0c142ce3311f6b5e6d9590d618fc22
2018-03-24 13:01:17 +01:00
Lance Bragstad
9bc92c563d Remove references to v2.0 from external developer doc
The external developer document we have attempts to clarify various
concepts in keystone and make it easier for other developers writing
other services. Now that we've removed the v2.0 API, it makes sense
to update this documentation to refer to v2.0 in the past tense. Some
parts of the document seemed specific to operator documentation, which
has been either removed or reworked to the intended operators, other
service developers.

Change-Id: I809150f8b77a813e2300760fdcb1d11cfa8ca732
2018-03-21 16:58:47 +00:00
Lance Bragstad
c402691371 Remove references to UUID from token documentation
Support for the UUID token provider was removed when the Rocky cycle
opened for development:

  I76d5c29f6b1572ee3ec7f2b1af63ff31572de2ce

This commit removes references to the UUID token provider from the
token provider documentation.

Change-Id: I85aa4eac1098628f090b3e95a9234bc5777d274d
Partial-Bug: 1757151
2018-03-20 20:37:36 +00:00
Colleen Murphy
1b01ebce56 Add note to keystone-manage bootstrap doc
A lot of people are very surprised that we no longer reference port
35357 in our Ubuntu (and SUSE) install guides. Add a note to clarify
that this is not a bug and we do really mean it.

This does not change the RDO install guide because our guide still
instructs users to use port 35357 because the RDO package still includes
an Apache vhost file that uses 35357.

Change-Id: I334ba888190705a345d50cebe577b832753f202c
Related-bug: #1755026
Related-bug: #1755511
Related-bug: #1756178
2018-03-16 15:21:40 +01:00
Zuul
225a16fb83 Merge "Use OSC in application credential documentation" 2018-03-16 12:00:33 +00:00
OpenStack Proposal Bot
c16ed74402 Updated from global requirements
Change-Id: I196d41ddf16805197072a2182febfa4adef19f2d
2018-03-15 07:02:56 +00:00
Zuul
3c1270e306 Merge "Add user documentation for JSON Home" 2018-03-11 02:49:34 +00:00
Zuul
5de6fd0237 Merge "Consolidate identity-token-binding.rst" 2018-03-11 02:12:11 +00:00