summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoe Heck <heckj@mac.com>2012-01-29 13:24:38 -0800
committerJoe Heck <heckj@mac.com>2012-01-29 13:24:38 -0800
commitfec7598a07b4beca78fe31a549e5d3beb6c0dc5d (patch)
tree72e521e2a57b82d1384d6f969c097ff05bb6a096 /docs
parente643f239816bae29e8206407db3d5eabdd2ea4b0 (diff)
downloadkeystone-fec7598a07b4beca78fe31a549e5d3beb6c0dc5d.tar.gz
keystone-fec7598a07b4beca78fe31a549e5d3beb6c0dc5d.tar.xz
keystone-fec7598a07b4beca78fe31a549e5d3beb6c0dc5d.zip
shifting older docs into old/ directory
Diffstat (limited to 'docs')
-rw-r--r--docs/source/adminAPI_curl_examples.rst387
-rw-r--r--docs/source/configuration.rst2
-rw-r--r--docs/source/index.rst6
-rw-r--r--docs/source/old/configuringservices.rst (renamed from docs/source/configuringservices.rst)0
-rw-r--r--docs/source/old/controllingservers.rst (renamed from docs/source/controllingservers.rst)0
-rw-r--r--docs/source/old/endpoints.rst (renamed from docs/source/endpoints.rst)0
-rw-r--r--docs/source/old/extensions.rst (renamed from docs/source/extensions.rst)0
-rw-r--r--docs/source/old/middleware.rst (renamed from docs/source/middleware.rst)0
-rw-r--r--docs/source/old/middleware_architecture.rst (renamed from docs/source/middleware_architecture.rst)0
-rw-r--r--docs/source/old/migration.rst (renamed from docs/source/migration.rst)0
-rw-r--r--docs/source/old/nova-api-paste.rst (renamed from docs/source/nova-api-paste.rst)0
-rw-r--r--docs/source/old/releases.rst (renamed from docs/source/releases.rst)0
-rw-r--r--docs/source/old/services.rst (renamed from docs/source/services.rst)0
-rw-r--r--docs/source/old/ssl.rst (renamed from docs/source/ssl.rst)0
-rw-r--r--docs/source/serviceAPI_curl_examples.rst69
-rw-r--r--docs/source/usingkeystone.rst28
16 files changed, 4 insertions, 488 deletions
diff --git a/docs/source/adminAPI_curl_examples.rst b/docs/source/adminAPI_curl_examples.rst
deleted file mode 100644
index 81f96c36..00000000
--- a/docs/source/adminAPI_curl_examples.rst
+++ /dev/null
@@ -1,387 +0,0 @@
-..
- Copyright 2011 OpenStack, LLC
- All Rights Reserved.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
-=============================
-Admin API Examples Using Curl
-=============================
-
-These examples assume a default port value of 35357, and depend on the
-``sampledata`` bundled with keystone.
-
-GET /
-=====
-
-Disover API version information, links to documentation (PDF, HTML, WADL),
-and supported media types::
-
- $ curl http://0.0.0.0:35357
-
-or::
-
- $ curl http://0.0.0.0:35357/v2.0/
-
-Returns::
-
- {
- "version":{
- "id":"v2.0",
- "status":"beta",
- "updated":"2011-11-19T00:00:00Z",
- "links":[
- {
- "rel":"self",
- "href":"http://127.0.0.1:35357/v2.0/"
- },
- {
- "rel":"describedby",
- "type":"text/html",
- "href":"http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
- },
- {
- "rel":"describedby",
- "type":"application/pdf",
- "href":"http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf"
- },
- {
- "rel":"describedby",
- "type":"application/vnd.sun.wadl+xml",
- "href":"http://127.0.0.1:35357/v2.0/identity-admin.wadl"
- }
- ],
- "media-types":[
- {
- "base":"application/xml",
- "type":"application/vnd.openstack.identity-v2.0+xml"
- },
- {
- "base":"application/json",
- "type":"application/vnd.openstack.identity-v2.0+json"
- }
- ]
- }
- }
-
-GET /extensions
-===============
-
-Discover the API extensions enabled at the endpoint::
-
- $ curl http://0.0.0.0:35357/extensions
-
-Returns::
-
- {
- "extensions":{
- "values":[]
- }
- }
-
-POST /tokens
-============
-
-Authenticate by exchanging credentials for an access token::
-
- $ curl -d '{"auth":{"passwordCredentials":{"username": "joeuser", "password": "secrete"}}}' -H "Content-type: application/json" http://localhost:35357/v2.0/tokens
-
-Returns::
-
- {
- "access":{
- "token":{
- "expires":"2012-02-05T00:00:00",
- "id":"887665443383838",
- "tenant":{
- "id":"1",
- "name":"customer-x"
- }
- },
- "serviceCatalog":[
- {
- "endpoints":[
- {
- "adminURL":"http://swift.admin-nets.local:8080/",
- "region":"RegionOne",
- "internalURL":"http://127.0.0.1:8080/v1/AUTH_1",
- "publicURL":"http://swift.publicinternets.com/v1/AUTH_1"
- }
- ],
- "type":"object-store",
- "name":"swift"
- },
- {
- "endpoints":[
- {
- "adminURL":"http://cdn.admin-nets.local/v1.1/1",
- "region":"RegionOne",
- "internalURL":"http://127.0.0.1:7777/v1.1/1",
- "publicURL":"http://cdn.publicinternets.com/v1.1/1"
- }
- ],
- "type":"object-store",
- "name":"cdn"
- }
- ],
- "user":{
- "id":"1",
- "roles":[
- {
- "tenantId":"1",
- "id":"3",
- "name":"Member"
- }
- ],
- "name":"joeuser"
- }
- }
- }
-
-.. note::
-
- Take note of the value ['access']['token']['id'] value produced here (``887665443383838``, above), as you can use it in the calls below.
-
-GET /tokens/{token_id}
-======================
-
-.. note::
-
- This call refers to a token known to be valid, ``887665443383838`` in this case.
-
-Validate a token::
-
- $ curl -H "X-Auth-Token:999888777666" http://localhost:35357/v2.0/tokens/887665443383838
-
-If the token is valid, returns::
-
- {
- "access":{
- "token":{
- "expires":"2012-02-05T00:00:00",
- "id":"887665443383838",
- "tenant":{
- "id":"1",
- "name":"customer-x"
- }
- },
- "user":{
- "name":"joeuser",
- "tenantName":"customer-x",
- "id":"1",
- "roles":[
- {
- "serviceId":"1",
- "id":"3",
- "name":"Member"
- }
- ],
- "tenantId":"1"
- }
- }
- }
-
-HEAD /tokens/{token_id}
-=======================
-
-This is a high-performance variant of the GET call documented above, which
-by definition, returns no response body::
-
- $ curl -I -H "X-Auth-Token:999888777666" http://localhost:35357/v2.0/tokens/887665443383838
-
-... which returns ``200``, indicating the token is valid::
-
- HTTP/1.1 200 OK
- Content-Length: 0
- Content-Type: None
- Date: Tue, 08 Nov 2011 23:07:44 GMT
-
-GET /tokens/{token_id}/endpoints
-================================
-
-List all endpoints for a token::
-
- $ curl -H "X-Auth-Token:999888777666" http://localhost:35357/v2.0/tokens/887665443383838/endpoints
-
-Returns::
-
- {
- "endpoints_links": [
- {
- "href": "http://127.0.0.1:35357/tokens/887665443383838/endpoints?'marker=5&limit=10'",
- "rel": "next"
- }
- ],
- "endpoints": [
- {
- "internalURL": "http://127.0.0.1:8080/v1/AUTH_1",
- "name": "swift",
- "adminURL": "http://swift.admin-nets.local:8080/",
- "region": "RegionOne",
- "tenantId": 1,
- "type": "object-store",
- "id": 1,
- "publicURL": "http://swift.publicinternets.com/v1/AUTH_1"
- },
- {
- "internalURL": "http://localhost:8774/v1.0",
- "name": "nova_compat",
- "adminURL": "http://127.0.0.1:8774/v1.0",
- "region": "RegionOne",
- "tenantId": 1,
- "type": "compute",
- "id": 2,
- "publicURL": "http://nova.publicinternets.com/v1.0/"
- },
- {
- "internalURL": "http://localhost:8774/v1.1",
- "name": "nova",
- "adminURL": "http://127.0.0.1:8774/v1.1",
- "region": "RegionOne",
- "tenantId": 1,
- "type": "compute",
- "id": 3,
- "publicURL": "http://nova.publicinternets.com/v1.1/
- },
- {
- "internalURL": "http://127.0.0.1:9292/v1.1/",
- "name": "glance",
- "adminURL": "http://nova.admin-nets.local/v1.1/",
- "region": "RegionOne",
- "tenantId": 1,
- "type": "image",
- "id": 4,
- "publicURL": "http://glance.publicinternets.com/v1.1/"
- },
- {
- "internalURL": "http://127.0.0.1:7777/v1.1/1",
- "name": "cdn",
- "adminURL": "http://cdn.admin-nets.local/v1.1/1",
- "region": "RegionOne",
- "tenantId": 1,
- "versionId": "1.1",
- "versionList": "http://127.0.0.1:7777/",
- "versionInfo": "http://127.0.0.1:7777/v1.1",
- "type": "object-store",
- "id": 5,
- "publicURL": "http://cdn.publicinternets.com/v1.1/1"
- }
- ]
- }
-
-GET /tenants
-============
-
-List all of the tenants in the system (requires an Admin ``X-Auth-Token``)::
-
- $ curl -H "X-Auth-Token:999888777666" http://localhost:35357/v2.0/tenants
-
-Returns::
-
- {
- "tenants_links": [],
- "tenants": [
- {
- "enabled": false,
- "description": "None",
- "name": "project-y",
- "id": "3"
- },
- {
- "enabled": true,
- "description": "None",
- "name": "ANOTHER:TENANT",
- "id": "2"
- },
- {
- "enabled": true,
- "description": "None",
- "name": "customer-x",
- "id": "1"
- }
- ]
- }
-
-GET /tenants/{tenant_id}
-========================
-
-Retrieve information about a tenant, by tenant ID::
-
- $ curl -H "X-Auth-Token:999888777666" http://localhost:35357/v2.0/tenants/1
-
-Returns::
-
- {
- "tenant":{
- "enabled":true,
- "description":"None",
- "name":"customer-x",
- "id":"1"
- }
- }
-
-GET /tenants/{tenant_id}/users/{user_id}/roles
-==============================================
-
-List the roles a user has been granted on a tenant::
-
- $ curl -H "X-Auth-Token:999888777666" http://localhost:35357/v2.0/tenants/1/users/1/roles
-
-Returns::
-
- {
- "roles_links":[],
- "roles":[
- {
- "id":"3",
- "name":"Member"
- }
- ]
- }
-
-GET /users/{user_id}
-====================
-
-Retrieve information about a user, by user ID::
-
- $ curl -H "X-Auth-Token:999888777666" http://localhost:35357/v2.0/users/1
-
-Returns::
-
- {
- "user":{
- "tenantId":"1",
- "enabled":true,
- "id":"1",
- "name":"joeuser"
- }
- }
-
-GET /users/{user_id}/roles
-==========================
-
-Retrieve the roles granted to a user, given a user ID::
-
- $ curl -H "X-Auth-Token:999888777666" http://localhost:35357/v2.0/users/4/roles
-
-Returns::
-
- {
- "roles_links":[],
- "roles":[
- {
- "id":"2",
- "name":"KeystoneServiceAdmin"
- }
- ]
- }
diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
index 02fbd4b4..e16d1892 100644
--- a/docs/source/configuration.rst
+++ b/docs/source/configuration.rst
@@ -24,7 +24,7 @@ Configuring Keystone
man/keystone-manage
Once Keystone is installed, it is configured via a primary configuration file
-(:doc:`keystone.conf`), possibly a separate logging configuration file, and
+(``etc/keystone.conf``), possibly a separate logging configuration file, and
initializing data into keystone using the command line client.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 427414d4..8b12ff93 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -42,8 +42,8 @@ Getting Started
:maxdepth: 1
setup
- configuration
- configuringservices
+ configuration
+ configuringservices
community
Man Pages
@@ -53,7 +53,7 @@ Man Pages
:maxdepth: 1
man/keystone
- man/keystone-manage
+ man/keystone-manage
Developers Documentation
========================
diff --git a/docs/source/configuringservices.rst b/docs/source/old/configuringservices.rst
index 083c3ec5..083c3ec5 100644
--- a/docs/source/configuringservices.rst
+++ b/docs/source/old/configuringservices.rst
diff --git a/docs/source/controllingservers.rst b/docs/source/old/controllingservers.rst
index ba8bfc06..ba8bfc06 100644
--- a/docs/source/controllingservers.rst
+++ b/docs/source/old/controllingservers.rst
diff --git a/docs/source/endpoints.rst b/docs/source/old/endpoints.rst
index 84a42e09..84a42e09 100644
--- a/docs/source/endpoints.rst
+++ b/docs/source/old/endpoints.rst
diff --git a/docs/source/extensions.rst b/docs/source/old/extensions.rst
index 539bef39..539bef39 100644
--- a/docs/source/extensions.rst
+++ b/docs/source/old/extensions.rst
diff --git a/docs/source/middleware.rst b/docs/source/old/middleware.rst
index 69506ee2..69506ee2 100644
--- a/docs/source/middleware.rst
+++ b/docs/source/old/middleware.rst
diff --git a/docs/source/middleware_architecture.rst b/docs/source/old/middleware_architecture.rst
index a8c38f3c..a8c38f3c 100644
--- a/docs/source/middleware_architecture.rst
+++ b/docs/source/old/middleware_architecture.rst
diff --git a/docs/source/migration.rst b/docs/source/old/migration.rst
index 460d980b..460d980b 100644
--- a/docs/source/migration.rst
+++ b/docs/source/old/migration.rst
diff --git a/docs/source/nova-api-paste.rst b/docs/source/old/nova-api-paste.rst
index 586bac72..586bac72 100644
--- a/docs/source/nova-api-paste.rst
+++ b/docs/source/old/nova-api-paste.rst
diff --git a/docs/source/releases.rst b/docs/source/old/releases.rst
index a4b698d7..a4b698d7 100644
--- a/docs/source/releases.rst
+++ b/docs/source/old/releases.rst
diff --git a/docs/source/services.rst b/docs/source/old/services.rst
index d1c33381..d1c33381 100644
--- a/docs/source/services.rst
+++ b/docs/source/old/services.rst
diff --git a/docs/source/ssl.rst b/docs/source/old/ssl.rst
index 839e951e..839e951e 100644
--- a/docs/source/ssl.rst
+++ b/docs/source/old/ssl.rst
diff --git a/docs/source/serviceAPI_curl_examples.rst b/docs/source/serviceAPI_curl_examples.rst
deleted file mode 100644
index d05afc9f..00000000
--- a/docs/source/serviceAPI_curl_examples.rst
+++ /dev/null
@@ -1,69 +0,0 @@
-..
- Copyright 2011 OpenStack, LLC
- All Rights Reserved.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
-===============================
-Service API Examples Using Curl
-===============================
-
-The service API is defined to be a subset of the Admin API and, by
-default, runs on port 5000.
-
-GET /
-=====
-
-This call is identical to that documented for the Admin API, except
-that it uses port 5000, instead of port 35357, by default::
-
- $ curl http://0.0.0.0:5000
-
-or::
-
- $ curl http://0.0.0.0:5000/v2.0/
-
-See the `Admin API Examples Using Curl`_ for more info.
-
-.. _`Admin API Examples Using Curl`: adminAPI_curl_examples.html
-
-GET /extensions
-===============
-
-This call is identical to that documented for the Admin API.
-
-POST /tokens
-============
-
-This call is identical to that documented for the Admin API.
-
-GET /tenants
-============
-
-List all of the tenants your token can access::
-
- $ curl -H "X-Auth-Token:887665443383838" http://localhost:5000/v2.0/tenants
-
-Returns::
-
- {
- "tenants_links": [],
- "tenants": [
- {
- "enabled": true,
- "description": "None",
- "name": "customer-x",
- "id": "1"
- }
- ]
- }
diff --git a/docs/source/usingkeystone.rst b/docs/source/usingkeystone.rst
deleted file mode 100644
index bb52a94d..00000000
--- a/docs/source/usingkeystone.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-..
- Copyright 2011 OpenStack, LLC
- All Rights Reserved.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
-==============
-Using Keystone
-==============
-
-Curl examples
--------------
-
-.. toctree::
- :maxdepth: 1
-
- adminAPI_curl_examples
- serviceAPI_curl_examples