81 Commits

Author SHA1 Message Date
nonameentername
f6ac0661bf Update documentation to remove keystone-all
keystone-all command was removed but no alternative for running
keystone in developer mode was added.  Update documentation with uwsgi
command and update keystone-all reference.

Change-Id: Ia949620de21c1b05127769c6da249b38d83cda9c
2016-05-10 17:06:49 -05:00
Colleen Murphy
f7983d4bdf Update dev docs and sample script for v3/bootstrap
The default value for the admin_token parameter was removed from the
sample config file in ea952bd2, so the recommendation in the developer
documentation to use it without first setting it will result in an
error. This patch updates the developer documentation and the
sample_data.sh script to use the Identity v3 API and to follow the
latest recommendations for bootstrapping an admin user with which to
insert sample data.

Change-Id: I424ff6129d4ddcd63fb2bed4eabcbe910ab0153e
2016-03-17 15:11:37 -07:00
Colleen Murphy
9274861942 Fix keystone-manage example command path
Whether the user is using tox or has installed keystone globally, the
keystone-manage command should already be in their path. The keystone
repo doesn't have a bin/ directory so trying to call
bin/keystone-manage from the root of the repo will result in an error.
Moreover, other references to keystone-manage in this page do not
specify a path. This patch fixes the instruction and makes it
consistent with the rest of the document.

Change-Id: I93f1aca9bdef0fa3ef4937ef616157d1e1b6fbe9
2016-03-09 15:31:55 -08:00
Eric Brown
cde6f276a0 Minor edits to the developing doc
The tools/with_venv.sh no longer exists in the source tree. This
patch cleans up all references to it.

Closes-Bug: #1514792

Change-Id: I4638c9894fab01b4556ee0537bf40807a659e7e9
2016-03-02 17:01:09 +00:00
Brant Knudson
c420c81fcf Correct docstrings
There were several warnings logged when docs were built due to
invalid rst and other issues.

Change-Id: I61289d05377b8e70afbcf8786d4159354aa67ed8
2016-02-01 21:35:15 -05:00
Grzegorz Grasza
175b30b756 Online schema migration documentation
This is based on Nova upgrades documentation and links to Nova and
Cinder examples, since we are just starting to write backwards
compatible schema migration scripts.

Change-Id: Ie4bd5c28555e97df39465a5c793fc3306572a2c3
Partially-Implements: bp online-schema-migration
2016-01-22 12:02:36 +01:00
Dave Chen
87a9a6b563 Update developing.rst to remove extensions stuff
All keystone extensions have been moved into cores and are
enabled by default, the configuration about the extension in
this doc is not valid any more.

Change-Id: I0d1b7348d581b17d718c356fadad8f071ddbe09e
2015-12-15 05:38:31 +08:00
Brant Knudson
ec82f7b792 Document release notes process
Since we added support for reno, document that submitters should
provide release notes with their changes. Rather then expecting
others to provide them at the end.

Change-Id: I021dab1a6e34eb0b46c0676b26c669013118c118
2015-11-12 08:55:19 -06:00
Tom Cocozzello
5daaf840e7 Capitalize a Few Words
There are a few words that I have noticed throughout Keystone
that should be capitalized when they were not.  The few words
I fix are: Fernet, SQLite and MySQL.

Change-Id: Iba3ef08e35829ffb65f4c3e920066783a73e9d0b
2015-10-29 11:20:46 -05:00
Jin Nan Zhang
b6598abad8 change stackforge url to openstack url
because of the stackforge project move to openstack project,
so change the url to https://git.openstack.org/cgit/openstack/

Change-Id: I10070df0cf7222568e0e306e3b19612378baf30c
2015-10-20 16:31:23 +08:00
Nisha Yadav
65e64a9742 Replace sqlalchemy-migrate occurences from code.google to github
The OpenStack team started to handle the maintenance of
SQLAlchemy-migrate in their infrastructure. Their code repository is at
GitHub.There is some documentation inside the keystone project using
the link http://code.google.com/p/sqlalchemy-migrate/ . Since this is no
longer in use, the idea is to replace all the occurrences of
http://code.google.com/p/sqlalchemy-migrate/ by
https://github.com/stackforge/sqlalchemy-migrate

Change-Id: Ia17773058a7ea47f830f5b0c86b0be7332acece1
2015-10-01 14:56:48 +05:30
Brant Knudson
a0c531031a Move development environment setup instructions to standard location
According to [1], every project should publish instructions for
setting up a development environment to
http://docs.openstack.org/developer/<PROJECT_NAME>/devref/development.environment.html

Keystone's development environment setup instructions are moved
there for consistency.

[1] https://wiki.openstack.org/wiki/Getting_The_Code#Hacking_on_your_laptop_and_running_unit_tests

Change-Id: I084fd0dd9fc4f4ec768649718d86a8ccac990dfd
2015-09-23 15:18:32 -05:00
Ghe Rivero
e614b29940 Update exported variables for openstack client
When using openstack client to populate an initial keystone
deployment, instead of the former keystone client, the env.
variables needed are OS_TOKEN and OS_URL instead of the
previous OS_SERVICE_TOKEN and OS_SERVICE_ENDPOINT

Change-Id: I79dcd56896945267cf1c8ff4378ffff63048e155
2015-08-01 05:11:07 +02:00
Brant Knudson
d1873fc4ab Document sample config updated automatically
There's an infra job now to keep the sample config file
up to date so developers shouldn't propose config file updates
with their commits.

Change-Id: I154ccbf8c289a373c8cc02004244e1edfcc9f4af
2015-07-28 20:33:58 -05:00
Jenkins
f303c3ef5b Merge "Document use of wip up to developer" 2015-07-20 09:20:19 +00:00
Chloe Jensen
686c8735dd Modified command used to run keystone-all.
The keystone-all file no longer exists in bin/, but it is automatically
created when Keystone is installed. It was never removed as this bug
originally suggested.

Removing "bin/" from the command 'tools/with_venv.sh bin/keystone-all'
will make with_venv.sh use the keystone-all from the created virtualenv.

Change-Id: I04695f0548d6f87d632b87a40834323fea1378d7
Co-Authored-By: Akshay Aggarwal <akshayx.aggarwal@intel.com>
Co-Authored-By: Jason O'Brien <jasonx.obrien@intel.com>
Closes-Bug: #1462242
2015-07-07 17:43:47 +00:00
Brant Knudson
3a4f8489a7 Document use of wip up to developer
If the developer doesn't want to use the wip decorator, they
should be able to choose not to. This makes it clear that a
-1 shouldn't be applied if the developer decides not to use
wip.

Change-Id: If041cd1a4e3a1092ab47e6dd81ee03eb772c4c35
2015-06-24 16:57:02 -05:00
phil-hopkins-a
fa43b6f6d1 updates sample_data script to use the new openstack commands
Cleans up the sample_data script to replace the keystoneclient commands
with the new openstackclient commands

Change-Id: Id68ff2b466e582a0c2f4418d173f7d63c14f5f37
Closes-Bug: #1459816
2015-06-01 11:33:58 -05:00
Jenkins
d7798a2e8a Merge "Workflow documentation is now in infra-manual" 2015-05-19 13:21:59 +00:00
Jeremy Stanley
ccd49cf95d Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Also update some outdated/obsolete devstack-related URLs.

Change-Id: I84e3a62b0aec7cb62d10b8b41eac27b15326ab5c
2015-05-16 14:55:07 +00:00
Jenkins
c5a2d9482b Merge "Replace ci.o.o links with docs.o.o/infra" 2015-05-16 13:42:21 +00:00
Brant Knudson
2a3d4b30a7 Rename sample_config to genconfig
Most OpenStack projects use genconfig, so use that as our tox
venv.

Change-Id: I2edb5503a114b38fc4c719140fbee935b6b757e6
2015-05-15 10:16:42 -05:00
Jeremy Stanley
a2ab1fa103 Replace ci.o.o links with docs.o.o/infra
The http://ci.openstack.org/ documentation site has been deprecated,
replaced by redirects to corresponding paths within
http://docs.openstack.org/infra/ where other Project Infrastructure
documentation already resides.

Change-Id: Ifbc668063ad7cc8bee6b44279592ea6ca09c35ea
2015-05-14 21:38:20 +00:00
liu-sheng
37f3a8ad54 Replace github reference by git.openstack.org and change a doc link
* Replace the github by openstack's official home git.openstack.org
* Also update the like of developer documentation of keystone

Change-Id: I60e8e914d9fa3be2cdfffe029e4c2432c07962e2
2015-05-07 10:08:10 +08:00
Brant Knudson
4774440c59 Update testing docs
The testing docs had gotten out of sync with the test code.

Change-Id: I523579b4cccafe0630e1116746f16d31aa94ed1b
2015-04-03 12:03:44 -05:00
Jenkins
61d897afbf Merge "Correcting the name of directory holding dev docs" 2015-04-02 02:26:14 +00:00
darren-wang
4e130a79f0 Correcting the name of directory holding dev docs
In developing.rst there is an incorrect reference to the
directory in which the docs are generated.

Closes-Bug: #1438983
Change-Id: I4afa0194f5f7cab3c562806b052be6f4a8d38357
2015-04-01 07:29:43 +00:00
Dave Chen
0e2f47ae2f More content in the guide for core components' migration
Add some content in `developing.rst` for how to migrate core
components, primarly includes:

- The dir of core components should also includes version
  subdirectory.
- Files: `__init__.py` and `migrate.cfg` also needed for core
  components, so we should start a new section.
- Provide example for core components to upgrade or downgrade.

Change-Id: I7080609c043f856fc923a16473b4a49d5f7d06cd
2015-03-27 09:26:45 +08:00
Dolph Mathews
c0d56ecdf4 Rename test_keystoneclient*
Both of the test modules that perform functional (*cough* integration
*cough*) tests with python-keystoneclient are primarily focused on API
coverage for v2. All the analogous coverage for v3 is in the test_v3*
modules, so these two modules should be renamed so that they're easier
for new contributors to find.

Change-Id: Ib4264e5b9914177c48a63d239c1d05c743d62a26
2015-02-24 20:27:36 +00:00
David Stanek
3b7988f45d Adds a wip decorator for tests
This decorator can be used to commit failing tests while they are still
in development. It can also be used by people to show how an issue can
be reproduced without them having to make the code changes necessary to
make the test pass.

This is nicer than just raising TestSkipped because there is a built in
reminder to remove the decorator when the test starts passing.

Implements: blueprint failing-tests
Change-Id: I9ded266b368e7955b1e295950df394823b1a4088
2015-01-27 21:42:27 +00:00
Steve Martinelli
a02d95c408 Add rst code-blocks to a bunch of missing examples
Several examples were either missing code-blocks entirely,
this patch added either bash or python, so the rendered HTML
is nicer.

Change-Id: Ia145dc78a871dc27cf0926ea1ef9cf9b6df564b7
2014-09-04 17:13:23 -04:00
Steve Martinelli
2fdb53d461 Capitalize all instances of Keystone in the docs
There were quite a few instances of `keystone` where `Keystone`
should have been used. Code examples were not changed, since that
would break things.

Change-Id: I533ad1b71cc3af1b70bb54cca0a820aaad3f62da
2014-09-04 12:29:01 -04:00
Arun Kant
ea689ff78f Adding support for ldap connection pooling.
Using ldappool library to establish connection pooling.
Connection pooling is disabled by default.
Pooling specific configuration parameters are added in ldap section.
Added pool test using existing FakeLdap as connector class.
Added pool specific ldap live test. These tests are executed similar to
existing ldap live test.
Addressed async search_s and result3 API issues mentioned in review.
Added separate connection pool for end user auth bind done by keystone
identity ldap driver logic to avoid saturation of pool by these kind of
binds and limiting pool effectiveness for other ldap operations.
Rebased with lastest master and addressed doc comments.

Change-Id: If516a0d308a7f3be88df5583a30739a935076173
Closes-Bug: #1320997
bp: ldap-connection-pooling
DocImpact
2014-07-23 12:11:48 -07:00
Henry Nash
1a50986e7c multi-backend support for identity
The current code has a number of problems and limitations in its
support for having domain-specific backends (e.g. a different LDAP
server per domain).  Not least of the problems is that you cannot
always infer the domain if an API call is just handed a user_id or
group_id. These issues are so severe that this feature is currently
marked as experimental.

This patch fixes these issues by using a mapping layer to store
the domain and local ID for the public facing user and group IDs.
No API changes are required for this new support. An important
consequence of this change is that non-UUID IDs for backends
like LDAP do not escape from keystone.

To ensure backward compatibility with existing single backend
installations, the mapping is not used for the default driver.
An exception to this is that if a cloud provider wants to enable
mapping for the default LDAP driver then they can set a config
option to achieve this.

keystone-manage has been extended to provide options to purge
the mapping table.

Blueprint: multi-backend-uuids

Change-Id: I60f8965bb74b248e6a6c8f141289affa431ee3cf
2014-07-11 20:22:10 +01:00
David Stanek
f15471f5fd Corrects minor spelling mistakes
Change-Id: Ib603861ad19a525c112153ac3799f2cbe453d4f7
2014-06-24 13:50:31 +00:00
Brad Topol
6b01dbc91f Add instructions for removing pyc files to docs
So an issue I hit when following the getting started docs for developers
is that I forgot to remove old pyc files and that can cause
keystone-manage db_sync to throw errors.  I added some extra doc that
explains how to remove these files should this situation be encountered

Change-Id: Ib41c62e99faa7c82f89ab3c5bfa0d740f426829a
2014-06-14 22:44:38 -05:00
Steve Martinelli
5dbb794347 Fix spelling mistakes in docs
Noticed a bunch of minor spelling mistakes.

Change-Id: I8189dda5a78418820e6c56270089590ef87f1495
Closes-Bug: #1323361
2014-05-26 12:52:20 -04:00
Christian Berendt
6b891e3303 fixed typos found by RETF rules in RST files
rules are avaialble at https://en.wikipedia.org/wiki/Wikipedia:AutoWikiBrowser/Typos

Change-Id: Ia2b0e226d3f682fcba59907eadeb2a2c84972175
2014-05-02 15:34:30 +02:00
David Stanek
94809b08a2 Allows override of stdout/stderr/log capturing
During a test run stdout, stderr and log messages are being captured. If
the test fails all three will be printed out so that can be inspected.
Each stream has an environment variable that can be used to stop it from
being printed at the end of a test run by setting its value to 0. This
is in line with what many of the other project are already doing.

Environment variables:

 - OS_STDOUT_CAPTURE for stdout
 - OS_STDERR_CAPTURE for stderr
 - OS_LOG_CAPTURE for logging

Change-Id: I2fed99069950b839e060297026c8e06cbd45bb98
2014-03-25 15:55:59 +00:00
Morgan Fainberg
c726163357 Make LIVE Tests configurable with ENV
To enable ldap live test, set the environmental variable
``ENABLE_LDAP_LIVE_TESTS`` to a non-false value.

To enable tls ldap live test, set the environmental variable
``ENABLE_TLS_LDAP_LIVE_TESTS`` to a non-false value.

To enable mysql sql live test, set the environmental variable
``ENABLE_LIVE_MYSQL_TESTS`` to a non-false value.

To enable postgres sql live test, set the environmental variable
``ENABLE_LIVE_POSTGRES_TESTS`` to a non-false value.

To enable db2 sql live test, set the environmental variable
``ENABLE_LIVE_DB2_TESTS`` to a non-false value.

This allows for running all tests in a standard run by simply setting
the appropriate environmental variables.

This moves the live tests to be skips if the specific live-test
environmental variables are not set.

Change-Id: I8c09a8dcfca3f9691306c5f416f688205171bda3
Closes-Bug: 1243392
2014-03-17 13:52:55 -07:00
Arun Kant
0b5685962c Support for mongo as dogpile cache backend.
With this new optional caching backend, MongoDB can be used for caching data.

Change-Id: I25ba1cac9456d5e125a5eac99d42330507d4e329
Blueprint: mongodb-dogpile-caching-backend
2014-02-26 09:57:11 -08:00
Jenkins
72b794f267 Merge "Keystone doc has wrong keystone-manage command" 2014-02-22 08:51:11 +00:00
Morgan Fainberg
23a4fe9ec7 Update config options with helpstrings and generate sample
Restructure the common config to include many help strings to
support using the oslo.config auto-generated sample config file.

Closes-Bug: #1229941
Change-Id: If352b3b816b1e7dc8b5fc3b9c1cb2adab187ffda
2014-02-20 19:18:49 -08:00
Priti Desai
eb77167fe6 Keystone doc has wrong keystone-manage command
Fixed the keystone-manage command (--extension should be placed after db_sync)

Amend: making it more readable by seperating command from text

Change-Id: Iaf8dcacaa38cdcbaa867bb6e374a87c00cd45ac3
backport: none
Closes-bug: 1281819
2014-02-20 23:28:50 +00:00
Morgan Fainberg
57d02590f9 Implement mechanism to provide non-expiring keys in KVS
This patchset implements the ability to define non-expiring keys
for dogpile.cache backends. The non-expiring keys are relevant
in the case of drivers that can automatically remove keys after
a given time (e.g. memcache). This new non-expiring-key
functionality is currently only implemented for the provided
memcached backend.

bp: dogpile-kvs-backends
Change-Id: I7e25e0049e5b8697c5cb67272b660519c3c3305e
2014-02-19 15:54:41 -08:00
Morgan Fainberg
bcd65c43dd Cleanup Dogpile KVS Memcache backend support
General cleanup of the Dogpile KVS Memcache backends to be simpler
names and remove the 'dogpile_' prefix for the memcache_driver
argument utilized by the memcached backend pivot point. Documentation
updated to match KVS memcached changes.

DocImpact

Change-Id: Ieb368d440e48111d844c6e715ed17dd54ca50802
bp: dogpile-kvs-backends
2014-02-16 19:19:57 -08:00
Jenkins
f4e52af01c Merge "Implement list limiting support in driver backends" 2014-02-11 19:40:04 +00:00
Fabio Giannetti
d7be2902ad Style the code examples in docs as python
Add the appropriate styling macro for the code snippets in the
documentation. This change highlights the language syntax making
the documentation more readable.

Closes-Bug: #1276299

Change-Id: Id331be204f688ccbb6e9f2c7ab9287310477312b
2014-02-10 12:42:17 -08:00
Henry Nash
0dec4c8be9 Implement list limiting support in driver backends
Provides an optional limit to the number of rows that will be
returned by a backend from a list_{entity} call.  The limit is specified
in the configuration file, and allows for an overall general limit as
well as an individual limit for a given driver.  By default, there is
no limit.

Limitations:
    - The list limit is not yet handled by LDAP, rather this remains
      implemented in the final wrap collection - a subsequent patch
      will provide the support in the LDAP drivers

Implements bp list-limiting

Change-Id: I7ca76a8da4260242e578c44103b26257f7e2a5d5
2014-02-07 11:12:31 +00:00
Andreas Jaeger
c01d6dcc4f Change Continuous Integration Project link
The Continuous Integration Project link does not exist anymore as such.
Link instead to the documentation about the CI infrastructure.

Closes-Bug: #1274282
Change-Id: Ia69d9a3f89f67acee611222f411019395aa9d41c
2014-01-31 16:32:49 +01:00