← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nova/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/source/api_ext/ext_keypairs.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-05-24 13:12:53 UTC
  • mfrom: (1.1.55)
  • Revision ID: package-import@ubuntu.com-20120524131253-ommql08fg1en06ut
Tags: 2012.2~f1-0ubuntu1
https://launchpad.net/bugs/907197
* New upstream release.
* Prepare for quantal:
  - Dropped debian/patches/upstream/0006-Use-project_id-in-ec2.cloud._format_image.patch
  - Dropped debian/patches/upstream/0005-Populate-image-properties-with-project_id-again.patch
  - Dropped debian/patches/upstream/0004-Fixed-bug-962840-added-a-test-case.patch
  - Dropped debian/patches/upstream/0003-Allow-unprivileged-RADOS-users-to-access-rbd-volumes.patch
  - Dropped debian/patches/upstream/0002-Stop-libvirt-test-from-deleting-instances-dir.patch
  - Dropped debian/patches/upstream/0001-fix-bug-where-nova-ignores-glance-host-in-imageref.patch 
  - Dropped debian/patches/0001-fix-useexisting-deprecation-warnings.patch
* debian/control: Add python-keystone as a dependency. (LP: #907197)
* debian/patches/kombu_tests_timeout.patch: Refreshed.
* debian/nova.conf, debian/nova-common.postinst: Convert to new ini
  file configuration
* debian/patches/nova-manage_flagfile_location.patch: Refreshed

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/api_ext/ext_keypairs.rst
1
 
The Keypairs Extension
2
 
=================================================================
3
 
About this Extension
4
 
--------------------
5
 
This extension enables you to create or import a keypair on a virtual instance. If you send the name of the instance to the API, you get a key and a private_key and fingerprint returned. You can also send a public_key to add an existing ssh key and also list the keypairs in use on instances.
6
 
 
7
 
To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://mycloud.com/v1.1/tenant/extensions.
8
 
 
9
 
Extension Overview
10
 
~~~~~~~~~~~~~~~~~~
11
 
 
12
 
Name
13
 
        Keypairs
14
 
        
15
 
Namespace
16
 
        http://docs.openstack.org/ext/keypairs/api/v1.1
17
 
 
18
 
Alias
19
 
        OPS-KYP
20
 
        
21
 
Contact
22
 
        Jesse Andrews <anotherjesse@gmail.com>
23
 
        
24
 
Status
25
 
        Released
26
 
        
27
 
Extension Version
28
 
        v1.0 (2011-08-09)
29
 
 
30
 
Dependencies
31
 
        Compute API 1.1
32
 
        
33
 
Doc Link (PDF)
34
 
        http://
35
 
        
36
 
Doc Link (WADL)
37
 
        http://
38
 
        
39
 
Short Description
40
 
        This extension enables keypair listing, creation, or import into an instance through a REST API.
41
 
 
42
 
Sample Query Responses
43
 
~~~~~~~~~~~~~~~~~~~~~~
44
 
 
45
 
As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension. 
46
 
 
47
 
Extension Query Response: XML::
48
 
 
49
 
    TBD
50
 
 
51
 
.. todo:: Provide example of extension query XML response.
52
 
 
53
 
Extension Query Response: JSON::
54
 
 
55
 
        {"extensions": [{"updated": "2011-08-08T00:00:00+00:00", "name": "Keypairs", "links": [], "namespace": "http://docs.openstack.org/ext/keypairs/api/v1.1", "alias": "os-keypairs", "description": "Keypair Support"}]}
56
 
 
57
 
 
58
 
Document Change History
59
 
~~~~~~~~~~~~~~~~~~~~~~~
60
 
 
61
 
============= =====================================
62
 
Revision Date Summary of Changes
63
 
2011-09-16    Initial draft
64
 
2012-03-30    Reformat of content
65
 
============= =====================================
66
 
 
67
 
 
68
 
Summary of Changes
69
 
------------------
70
 
This extension to the Compute API allows keypair support so that you can create or import keypairs to secure your running instances. You can also list keypairs per user. 
71
 
 
72
 
This support is provided by the addition of new actions.
73
 
 
74
 
New Actions
75
 
~~~~~~~~~~~
76
 
When launching a new server, you can specify an already existing keypair with::
77
 
 
78
 
        POST /v1.1/tenant_id/os_keypairs/keypair
79
 
 
80
 
To lists the keypairs on all running instances, use::
81
 
 
82
 
        GET /v1.1/tenant_id/os_keypairs
83
 
 
84
 
New Faults
85
 
~~~~~~~~~~
86
 
None
87
 
 
88
 
New Headers
89
 
~~~~~~~~~~~
90
 
None
91
 
 
92
 
New Resources
93
 
~~~~~~~~~~~~~
94
 
None
95
 
 
96
 
New States
97
 
~~~~~~~~~~
98
 
None
99
 
 
100
 
Changes to the Cloud Servers Specification
101
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102
 
 
103
 
This section lists the specific changes to the Compute API, namely adding a new section to the 4.3 Server Actions section.