Commit Graph

27 Commits

Author SHA1 Message Date
Doug Hellmann 1c7f556d4f rearrange existing documentation to follow the new layout standard
This change moves existing files, updates a few of the cross-references
and paths, and fixes some formatting. It is not meant to be the final
word on how the main page looks or how the other files are organized,
but it gets everything roughly into shape. If the glance team wants to
make changes, please do those as follow-up patches

This change depends on the spec and on a feature of pbr that allows us
to move where the auto-generated class reference documentation ends up
in the tree.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Change-Id: I9dde267793a5913acb5b1ec028cfb66bc5189783
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00
Tom Cocozzello adfc7e5a3f fix docstring warnings and errors
There are many warnings and errors that occur when the docs are
generated.

Co-Author-By: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
Closes-Bug: 1556818
Change-Id: Ifebeb3904f136a56bd6fe6877220b279a1f98354
2016-03-14 18:40:15 +00:00
Henrique Truta e9130a1af7 Encourage usage of identity API v3
Identity API v2.0 will be marked as deprecated in Mitaka.
Keystone team is then moving towards making all components use
API v3 by default.

Change-Id: I3c3007028381dcab92075efd390d16aed3c36bcd
2016-02-22 11:40:00 -03:00
Andy McCrae 1951e1639f Adjust authentication.rst doc to reference "identity_uri"
The "auth_port", "auth_host", and "auth_protocol" variables were
deprecated in favour of a single "identity_uri" variable.

* Adjust authentication.rst doc to reference "identity_uri"

Change-Id: I48de53f21b8d767b276858ed274066015d765f0e
Closes-Bug: #1361613
2014-10-11 20:56:36 +01:00
Brant Knudson adeca09124 Use auth_token from keystonemiddleware
The auth_token middleware in python-keystoneclient is now
deprecated and has been moved to keystonemiddleware.

Closes-Bug: #1342274

Change-Id: Ic8ba2d2f470ec052ba13c3b63b26d5e2270f7412
2014-07-15 18:36:14 +00:00
Stuart McLaren bd8cfcb247 Small change to 'is_public' documentation
Update the documentation for 'is_public' in authentication.rst
to be more accurate.

Addresses bug 1177732.

Change-Id: I9889826d4019ff33d9be343e79324862d9fde8e9
2013-05-08 15:25:25 +00:00
annegentle a2b9bed75d Updates OpenStack LLC with OpenStack Foundation
Patchset addresses reviewer's comments, rebase against master,
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright

Change-Id: I94367461505778973528eb8835d991f4fb796dab
2013-02-17 19:19:43 -08:00
Dan Prince cae7672332 Updates keystone middleware classname in docs.
Change-Id: If6a5b74c2fe7855b28aaded7b93228dbd0de9845
2012-11-28 16:12:29 -05:00
Brian Waldon 48bb44b9aa Drop glance client + keystone config docs
The blurb about configuring glance client doesn't belong in the
server project documentation. This removes it.

Related to bp glance-folsom-docs-cleanup

Change-Id: I3932e1af382813bf069f4920218dd60cd04790f5
2012-09-03 13:42:36 -07:00
Brian Waldon 991e4bd8de Tweak doc page titles
Related to bp glance-folsom-docs-cleanup

Change-Id: Ifc4d8371c0752997258e19e7b149ae88ec3413b0
2012-08-29 08:54:40 -07:00
Brian Waldon 34d6335672 Remove repeated image-sharing docs
* Drop image sharing blurb from authentication docs.
* Link to authentication page from api page

Related to bp glance-folsom-docs-cleanup

Change-Id: Idac46a78f79fac0c673f6a9b91c1f44df7b705b4
2012-08-29 08:53:54 -07:00
Brian Waldon eb4aaa97bd Split noauth context middleware into new class
Use UnauthenticatedContextMiddleware in the case that you want to deploy
without an auth service. ContextMiddleware is now solely for authenticated
requests.

* Rewrite ownership tests for adding/updating images through the v1 API
* Fixes bug 992859

Change-Id: I608671aac8300c9195769542708708afda991e04
2012-05-03 09:00:07 -07:00
Joe Gordon f0a0c4a000 Cleanup authtoken examples
* remove auth_uri - do not need when set auth_port, auth_host, auth_protocol
* remove servce_*  variables - not needed in new keystone
* update associated documentation

Change-Id: I9bf7d53f7d62371848645a242ae63f77b42319db
2012-05-01 15:38:07 -07:00
Brian Waldon bd305fa07b Merge registry context with common context
Pull the extra methods defined in glance.registry.context:RequestContext into
glance.common.context:RequestContext. This is necessary as the new v2 API
implementation talks directly to the database.

* Partially implements bp api-2

Change-Id: Ia8c1fde511bdca69be0dcf61ce12976ace5f7dc3
2012-04-26 08:53:24 -07:00
Brian Waldon 5bd453b14e Remove keystone.middleware.glance_auth_token
* The use of this middleware is no longer necessary
* Fixes bug 957501

Change-Id: I2536babe6b34aa0cb6aca2b3e768ac85800f93e7
2012-03-16 15:53:23 -07:00
Jenkins e1fae1d4bb Merge "Add admin_role option" 2012-03-16 20:35:25 +00:00
Brian Waldon eff04c5612 Add admin_role option
* Allow a deployer to define the role that should give an authenticated
  user admin privileges. Defaults to 'admin'
* Fixes bug 956547

Change-Id: I018b9c438a12c527833ed8e2e6c377a93fde9130
2012-03-16 11:50:20 -07:00
Brian Waldon 9f2de6c1e4 Remove references to admin_token
* Fixes bug 957193

Change-Id: Id9e03dd195f4d859a983703b1ed1db0700ffd29d
2012-03-16 11:46:53 -07:00
Brian Waldon 3a8103e68c Updating authentication docs
* Update docs to reflect correct attribute names for configs and env vars
* Remove old env var conversion tool
* Fixes bug 952405

Change-Id: I45b2519fe97e76987a9e0acda14b303ba75afd02
2012-03-14 18:03:06 -07:00
Eoghan Glynn 6cac288a87 More flexible specification of auth credentials.
Fixes bug 853933

Add new --username|--password|--tenant|--auth_url|--auth_strategy
switches to bin/glance to allow the username, password, tenant name,
and authentication URL & strategy be specified on the command line.

Avoid needlessly falling back to keystone v2 auth after a successful:

  GET /v1.0/tokens

returns with the X-Image-Management-Url or X-Glance header set,
as opposed to X-Server-Management-Url.

Extend the keystone functional test support to ensure that the URL
returned by keystone via the X-*-Url header contains the appropriate
dynamically allocated port for the glance API service.

Ensure the underlying $OS_* environment variables do not leak into the
TestPrivateImagesCli functional tests, also explicitly exercise both
noauth and keystone strategies.

Change-Id: Iee8bf3745d65a9c57a9da803d5cf9ae5f343a159
2012-01-24 17:45:41 +00:00
Eoghan Glynn 5835b30cc2 Avoid the need for users to manually edit PasteDeploy config in order to switch pipelines.
Define multiple pipelines in glace-api.conf to reflect the
various supported deployment flavors (minimal, with caching,
with cache management, with keystone-based auth etc.).

Add an optional paste_deploy.flavor config variable to allow the
user select the appropriate pipeline without having to edit the
paste config (i.e. uncommenting lines as before). For example
in glance-api.conf, a setting of:

  [paste_deploy]
  flavor = keystone+caching

identifies the following pipeline in glace-api-paste.ini:

  [pipeline:glance-api-keystone+caching]
  pipeline = versionnegotiation authtoken auth-context cache apiv1app

the advantage being that the user need not be concerned with
the precise sequence of filters required to realize the QoS
they desire.

Modify the functional tests that patch configuration (i.e. the
keystone and caching tests) to use the new deployment_flavor
mechanism.

Extend the TestConfigOpts to support option groups.

Change-Id: Ide843ada11bce115b7dc650440397853c6409b03
2012-01-17 12:00:33 +00:00
Eoghan Glynn 14593a3b96 Split out paste deployment config from the core glance
*.conf files into corresponding *-paste.ini files.

Fixes LP #815208

Change-Id: I5acb8488cc25bb3c7dd735c8c2b0fe62fcea8e5e
2012-01-17 11:40:26 +00:00
Lorin Hochstein 6bf61e8ce1 Added some examples for "glance add"
Fixed some warnings.

Change-Id: I9658c7458f3073b4bab93d0105d6ba174a4d0ca1
2011-11-29 13:10:50 -05:00
Rick Harris 94dcf3acd0 Using Keystone's new port number 35357.
Fixes bug 888753

Change-Id: I22894a31ee54edd6d00ac3458ea4a2f8842aa4a0
2011-11-10 23:33:45 +00:00
Kevin L. Mitchell 5b27c663b9 Better document using Glance with Keystone.
Addresses bug 871803 by expounding on what configuration should
look like.  Also fixes the example config files, which generally
had the authentication setup completely wrong.

Change-Id: I44b2b8bd340ca95b5a2c2e9408797b0308000a65
2011-10-13 17:03:39 +00:00
Rick Harris e7d06e409e Documenting nova_to_os_env.sh tool
Change-Id: I4a416e01e4333b43a75944ace01e8b0abe3ec2a3
2011-09-20 18:06:48 -05:00
Kevin L. Mitchell 1e4be06cb2 Add support for shared images
Change-Id: I3822a3841e1c10717c180052f929688b9f21a841
2011-08-15 16:20:49 -05:00