Commit Graph

72 Commits

Author SHA1 Message Date
Takashi Kajinami e3b3df7974 Remove babel.cfg
Remove babel.cfg and the translation bits from setup.cfg, those are not
needed anymore.

Change-Id: I6c44c8e0b8bf16af2e91ba26b2dbe37c06ea1048
2023-12-21 02:16:12 +09:00
Zuul 1ac30ab59f Merge "Add default service role support to boostrap command" 2023-08-04 08:07:44 +00:00
Stephen Finucane 8c789fbe73 doc: Correct typo
A contract migration will use the '--contract' flag, obviously.

Change-Id: I288bd0175834fdd3ee8d224f099e37b6294cb7ea
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2023-07-13 10:03:47 +01:00
Stephen Finucane 66d289f033 doc: Add minimal documentation on generating migrations
We can now auto-generate migrations. Document how this is done.

Change-Id: I754b0eb9eb74cd31f22440c64187d292c19ce4fa
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2023-06-28 11:14:24 +01:00
Abhishek Kekane d0eacc4729 Add default service role support to boostrap command
Added service role support to bootstrap command.

Closes-Bug: #1951632
Change-Id: I9cb25a111c84ecb3a09158cbe44b0954df89096c
2023-03-28 17:51:17 +00:00
Stephen Finucane d88439c6a9 docs: Update docs to reflect migration to Alembic
Change-Id: Iabc8cd0746871ea6ab81af9d3f0149644a489f3d
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-06-20 13:29:58 +01:00
Nikita Koltsov fc62bbc06a Fix typo in documentation
Change-Id: I92a8cfaef350bb61330d9ef02c0fd9e6f6c5854a
2022-05-16 12:50:37 +02:00
Stephen Finucane aebd037f50 sql: Move migrations to 'legacy_migrations'
We're going to add new alembic-based migrations shortly. These will live
in the 'keystone.common.sql.migrations' module. Prepare for this by
moving the existing migrations from ''keystone.common.sql' into a common
'keystone.common.sql.legacy_migrations' module.

Change-Id: I5ab7b010b21268977f73738e895bbd21442e9455
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-01-21 13:39:30 +00:00
Stephen Finucane 503421d3d4 sql: Remove legacy 'migrate_repo' migration repo
This is now folded into the initial migration of the 'expand_repo'
repository. Previously, this was a dummy migration. We simply move
things across and remove any code that was trying to work with the older
repo since it's no longer necessary.

A release note is added, even though it's not really necessary since
nothing will change for users. It's more of a heads up that things are
afoot.

Change-Id: I59882d88fe593ec1ae37415b2157584f7f3c85f8
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-01-10 18:31:09 +00:00
Ghanshyam Mann f8cd58da90 Moving IRC network reference to OFTC
Change-Id: I3e4944d47ba8192b4a1f0350347e4dc68d811895
2021-07-16 13:58:33 +00:00
Zuul 04bfafff8b Merge "Update caching-layer.rst" 2020-06-16 15:43:58 +00:00
Zuul c27c9d258d Merge "Update filtering-responsibilities and truncation" 2020-06-09 11:20:20 +00:00
Vishakha Agarwal 28512ca569 Update caching-layer.rst
This patch updates about the implementation of oslo.cache for
caching in keystone.

Change-Id: I8b5b4d3c8d8b3ae99305cc69657571f5983e1004
2020-06-01 12:29:12 +05:30
Zuul 73dc3cebd3 Merge "Update doc id-manage.rst" 2020-05-30 09:44:16 +00:00
Zuul 73a66464f3 Merge "Update keystone Making an API Change doc" 2020-05-26 18:33:02 +00:00
Vishakha Agarwal a483f1c2c6 Update keystone Making an API Change doc
This patch removes the information about router.py and
controller.py used in wsgi model and updates about the new
API's written when adopting Flask Application.

Change-Id: I902647472a0df69f2fa402aec84eac9d94701a2c
2020-05-21 05:43:46 +00:00
Vishakha Agarwal db57d74fe4 Update filtering-responsibilities and truncation
This patch updates the change of architecture in keystone by the
removal of controllers.

Change-Id: I19fa04e3293e950d7a33874bc92937c7cbf47176
2020-05-20 16:28:00 +05:30
Vishakha Agarwal f8317375ab Update doc id-manage.rst
This patch removes about controller and replaces it with API. It
also add some links to the details mentioned in doc.

Change-Id: I558e6db1e0e920a5a22c1708e35553f1af678476
2020-05-20 14:48:27 +05:30
Vishakha Agarwal 39d66ac78c Update contributors document keystone
Python2.7 support is removed from Ussuri Cycle. Thus
updating the rst files regarding the same.

Change-Id: I5a75eac3926ac01565019afbb223df8bf599a69f
2020-04-08 20:19:07 +05:30
Vishakha Agarwal 143f07f545 Community goal: Adding contributing.rst
http://lists.openstack.org/pipermail/openstack-discuss/2020-February/012364.html

Change-Id: Ifc74072a5b7ae90910100093450e89f98d5dcb53
2020-03-25 18:52:03 +05:30
Vishakha Agarwal 9fed446b0a Updating tox -e all-plugin command
all-plugin is deprecated and is going to be removed soon.
It is being replaced by "all" [1].

[1] 181a26d258/tox.ini (L82)

Change-Id: I2911caa169e063fdaf06933598b52bbb7f5f338a
2020-01-21 15:55:26 +05:30
Colleen Murphy d75b2552bf Refresh "how can I help?" doc
Add prose about why someone might want to contribute to keystone and
reduce the emphasis on developer-specific contributions.

Change-Id: Ied32aac47e098d25fd9880a12c617574d5e24ace
2019-10-28 15:47:21 -07: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 76f9be7788 doc: Fix broken links
There's invalid RST for links in some doc files.

You cannot write:
.. _unscoped token: :doc:`../admin/tokens`

This gets linked to as
"https://docs.openstack.org/keystone/latest//contributor/:doc:%60../admin/tokens%60"

Fix all occurences that I found.

Change-Id: I8556bd9e1cbe661fe54fa6361e93f6041cdc9272
2019-07-26 12:26:10 +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 8a03cd8551 Add exercises for intern applicants
At the Train PTG, we discussed[1] what we could do to continue to
participate in open source internship programs like Outreachy while
keeping the high volume of applicants manageable. Outreachy requires
applicants to submit a contribution to the project they are applying
for, but we rarely have sufficient numbers of low-hanging-fruit tasks to
assign to all of them to allow all of them to make useful contributions.
Instead, we propose to give them exercises that most likely will not be
merged into keystone itself. These exercises are much more difficult
than typo fix tasks, and can be assigned to multiple people without
concern for applicants stepping on each others' toes. They can also help
new contributors get familiar with the architecture of keystone and the
development workflow, and encourages them to interact with the team.

[1] https://etherpad.openstack.org/p/keystone-train-ptg-outreachy-brainstorm

Change-Id: I615b1c029db59a1f9d8548dc0a80faa5c4150f2a
2019-07-10 13:42:20 -07:00
Zuul 2b1a917e95 Merge "Fix contributor doc of keystone" 2019-06-19 16:45:09 +00:00
Zuul d5da988792 Merge "Add link to describe Principle of Least Privilege" 2019-06-19 07:33:16 +00:00
Vishakha Agarwal 0a9d7cbec5 Fix contributor doc of keystone
Since keystone now tracks features as Bugs not
blueprints. This patch updates the same in the
contributor doc.

Change-Id: Ic51205c1403f2085d7f921d3ff9d667cfe3f4c87
2019-06-19 11:43:40 +05:30
Zuul 94a1b57897 Merge "Update mission statement and vision reflection" 2019-06-18 21:00:29 +00:00
Colleen Murphy 0f7a1c47c8 Add link to describe Principle of Least Privilege
Add a link to the vision reflection to clarify the meaning of the
Principle of Least Privilege, which is a significant theme in our vision
document.

Change-Id: Iad751761fcc143f4549a19c4c3d262bbee0419c4
2019-06-18 12:05:09 -07:00
Lance Bragstad dd30a88eb6 Update the meaning of low-hanging-fruit
During the Train PTG, the team discussed ways to better engage
newcomers and folks who don't have fulltime responsibility upstream.
One way we can do that is by doing a better job describing and
applying `low-hanging-fruit` in bug triage.

This commit attempts to introduce consistency for that specific bug
tag.

Change-Id: Ib6ea0b62ad95335ed2d9b26687708cd664bf3648
2019-06-17 18:13:33 +00:00
Colleen Murphy 6f6f78c211 Update mission statement and vision reflection
As discussed during the Train PTG[1], update the mission statement to
include discovery and resiliency, and update the vision reflection to
include Bidirectional Compatibility and Secure by Design.

Support for quota management could be read as included under
"user-friendly...multitenant" in the mission statement.

[1] https://etherpad.openstack.org/p/keystone-train-ptg-vision-mission

Change-Id: I195d5ae5affb84feaee63598d2c927db2faa20b7
2019-05-29 15:29:47 -07:00
ZhongShengping 5f90447b40 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: I7cd39dacaa1f2cdc2d74da39ae3971246e922907
2019-04-24 11:51:00 +08:00
Colleen Murphy ff54595694 Add keystone's technical vision reflection
This change adds a response to the TC's request for a self-reflection[1]
against the TC's technical vision for OpenStack[2] and serves as a
big-picture guide for the future of keystone development.

[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-January/001417.html
[2] https://governance.openstack.org/tc/reference/technical-vision.html

Change-Id: I0c6c4e97d95284287ffba2921e620cb0f033dc7c
2019-03-26 17:39:07 +01:00
Zuul 1caca06ced Merge "Remove external-dev and consolidate to contributor" 2019-03-26 15:35:06 +00:00
Ian Wienand 4e523ce422 Replace openstack.org git:// URLs with https://
This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.

This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.

This update should result in no functional change.

For more information see the thread at

 http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html

Change-Id: Ic878f69afe5eaf9ec22194944c2dfd8e1ead0542
2019-03-24 20:33:58 +00:00
Gage Hugo 727aea34cf Remove external-dev and consolidate to contributor
The current external-dev.rst page only contains 3
links that are semi-hidden in the current docs layout
unless someone specifically clicks on the
"External Developer" link.

This change removes the external-dev page, which only
contained 3 links, and now those 3 links are available
on the contributor index. These links also now show
up on the main keystone documentation page as well for
easy access to readers.

Change-Id: Ib0106ade10f1760a91bbac8e3c8e43b1aeda0884
2019-03-22 10:45:37 -05:00
Matt Riedemann 45c514e907 Fix typo in docs section header
Now I get that sweet sweet keystone ATC status!

Change-Id: I05cad80b4985d5ed5f73b76eb8dbca92c5954761
2019-03-21 12:15:56 -04:00
Lance Bragstad 87d6c019b1 Add service developer documentation for scopes
We have documentation on the various scopes keystone offers, but we
don't describe *how* other developers in OpenStack should use this
information.

This commit attempts to answer some of the most common authorization
scope questions we've heard and fixes up some wording to make the
document more clear.

Change-Id: Iaf53e632e1c4e7c2ef1fcbf0262d99d896c06157
2019-03-06 19:33:19 +00:00
Zuul 77e50e49c5 Merge "Update introduction of external services doc" 2019-02-23 00:44:07 +00:00
Lance Bragstad 4d2a219a3b Update introduction of external services doc
This document is written for other developers working on OpenStack.
Its goal is to describe various concepts in a way that other
developers, who may not be familiar with keystone, can digest and use
effectively in their projects.

The introductory paragraph was phrased as if the v3 API just became a
thing, when it has actually been around for a long time. It also
eluded to underlying implementation details by mentioning paste
pipelines, which we no longer use.

This commit updates the introduction to be more relevant to the state
of things today.

Change-Id: I79564dc99fd65a5609bd548d12a0413ca3ee6b2a
2019-02-22 00:48:29 +00:00
Lance Bragstad 3111b8b9bb Address follow-up comments in contributor guide for specs
We recently merged a document for describing how to write
specifications and open bug reports to track feature work:

  I5dbf6f81058de3f2a64a95e4cf34a1279a49c5dd

This commit addresses some follow on comments from the initial review,
namely:

  * removes copyright dates
  * reorders opening RFE bugs before proposing specs to be consistent
    with the specification template
  * fixes links to be more descriptive
  * clarifies some details on the spec writing process

Change-Id: I883beed7c9b731ec69d169702b03652c98307f85
2019-02-19 20:26:21 +00:00
Lance Bragstad 833df8cd19 Add documentation for writing specifications
We have a specification template and a keystone-specs repository, but
we don't offer any documentation or guidance on the specification
process we have.

This commit aims to clarify the difference between specifications and
RFE bug reports, and why we use both. It also describes the process
someone should follow if they want to file a feature request against
the project.

Change-Id: I5dbf6f81058de3f2a64a95e4cf34a1279a49c5dd
2019-02-16 02:16:49 +00:00
Colleen Murphy 46b30535cf Move identity sources doc to admin guide
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
2018-12-12 08:45:34 +01:00
Colleen Murphy ccb3d340e4 Rename admin guide pages
Some of the admin guide pages were prefixed with "identity-" because
they came from the centralized install guide or operators guide or
security guide or somewhere else. We don't need the prefix, everything
in keystone is identity. Remove the prefix from the affected pages so
that everything is consistent.

Change-Id: Icd172a39fe720472f1fb15395178f90282696ac9
2018-12-11 11:43:50 +01:00
Suramya Shah b3c89e8c3f Consolidate Keystone docs: admin/identity-external-authentication.rst
Consolidate advanced-topics/external-auth.rst into
admin/identity-external-authentication.rst.

Change-Id: Ic4e9c37f41c4998fbdfe4b21c7b57b2de4776432
2018-12-11 10:00:38 +01:00
wangxiyuan 58f7827ce7 Update contributor doc
1. Remove some invalid links
2. Remove `paste` related doc
3. Fix some nits.

Change-Id: Iefdc12dd3b93ff7b2d6df635bc849a0c9b42f171
2018-11-21 10:28:52 +08:00
Zuul 5ff37f1028 Merge "Add scope documentation for service developers" 2018-11-20 07:57:54 +00:00
Lance Bragstad a383867cdb Add scope documentation for service developers
We have a document that attempts to help describe keystone concepts
to other OpenStack developers. Now that we've added system scope to
keystone, it makes sense to refresh this document and make it more
helpful for services.

This should help services consume various scopes to protect APIs at
various levels (project, domain, system, et cetera).

Change-Id: I1a92ed0b6bbba44d1050a857c3609d918bb25b86
Closes-Bug: 1757151
2018-11-19 22:20:55 +00:00