Jump to: navigation, search

Difference between revisions of "Nova-scheduled-images-extension"

(→‎Sample server detail response (JSON))
(→‎Sample server detail response (XML))
Line 180: Line 180:
 
     OS-EXT-STS:vm_state="building" OS-EXT-STS:task_state="spawning"
 
     OS-EXT-STS:vm_state="building" OS-EXT-STS:task_state="spawning"
 
     OS-EXT-STS:power_state="0" OS-DCF:diskConfig="AUTO">
 
     OS-EXT-STS:power_state="0" OS-DCF:diskConfig="AUTO">
−
    <OS-SI:image_schedule>
 
−
        <retention>7</retention>
 
−
    </OS-SI:image_schedule>
 
 
     <image id="3afe97b2-26dc-49c5-a2cc-a2fc8d80c001">
 
     <image id="3afe97b2-26dc-49c5-a2cc-a2fc8d80c001">
 
         <atom:link
 
         <atom:link
Line 195: Line 192:
 
     <metadata>
 
     <metadata>
 
         <meta key="My Server Name">API Test Server XML</meta>
 
         <meta key="My Server Name">API Test Server XML</meta>
 +
        <meta key="OS-SI:image_schedule"><retention>7</retention></meta>
 
     </metadata>
 
     </metadata>
 
     <addresses>
 
     <addresses>
Line 215: Line 213:
 
</server>
 
</server>
 
</nowiki></pre>
 
</nowiki></pre>
−
 
  
 
=== Additional Query Parameter on List Servers Requests ===
 
=== Additional Query Parameter on List Servers Requests ===

Revision as of 06:18, 18 February 2013

This is the full specification for blueprint: https://blueprints.launchpad.net/nova/+spec/scheduled-images

Nova Scheduled Images API Extension

Summary

Name 
Scheduled Images Extension
Namespace 
`http://docs.openstack.org/servers/api/ext/scheduled_images/v1.0`
Alias 
OS-SI
Dependencies 
OpenStack Compute API v2.0
Short Description 
Enables automatic daily images to be taken of a server.
Doc Link (WADL) 
(Forthcoming.)
Doc Link (XSD) 
(Forthcoming.)
New Headers 
None.
New Faults 
None.
New Actions 
None.
New Resources 
Detailed below.

New Resources

A new resource is created at `/{tenantId}/servers/{serverId}/OS-SI/image_schedule` to indicate that this server will be monitored by the scheduled images service. This resource contains a positive integer value, the `retention`. The `retention` value indicates the number of images created by the scheduled images service that will be retained in the user's cloud storage account. Scheduled images (and the associated retention value) are configurable per server. The cloud provider may choose to set a maximum allowable retention value.

Enable scheduled images

POST /{tenantId}/servers/{serverId}/OS-SI/image_schedule

Request body: 

{
   "image_schedule" : {
      "retention": <positive integer>
   }
}

Retention: Specifies the number of snapshots created by the scheduled images service to keep for a server. If a retention value has already been specified for an server, it is overridden.

Error Conditions: a negative integer or zero is used as the retention value, or a retention value is specified that exceeds a limit set by the cloud provider.

Disable scheduled images

Disable scheduled images by deleting the resource "marker" that indicates that the scheduled images service should create snapshots of this server. 

DELETE /{tenantId}/servers/{serverId}/OS-SI/image_schedule

No response body.

Show scheduled images setting

 GET /{tenantId}/servers/{serverId}/OS-SI/image_schedule

(If the scheduled images feature is not enabled for this server, the API will return a 404.)

Response Body: 

{
   "image_schedule" : {
      "retention": <positive integer>
   }
}


Change to Server Detail Response

Addition of the Image Schedule

The image schedule resource is added to the server detail response returned from the existing Nova requests for those servers for which an image_schedule has been created. These requests are: 

GET /{tenantId}/servers/{serverId}
GET /{tenantId}/servers/detail


Sample server detail response (JSON)

{
    "server": {
        "OS-DCF:diskConfig": "AUTO",
        "OS-EXT-STS:power_state": 1, 
        "OS-EXT-STS:task_state": null, 
        "OS-EXT-STS:vm_state": "active", 
        "accessIPv4": "198.101.241.238", 
        "accessIPv6": "2001:4800:780e:0510:d87b:9cbc:ff04:513a", 
        "addresses": {
            "private": [
                {
                    "addr": "10.180.3.171", 
                    "version": 4
                }
            ], 
            "public": [
                {
                    "addr": "198.101.241.238", 
                    "version": 4
                }, 
                {
                    "addr": "2001:4800:780e:0510:d87b:9cbc:ff04:513a", 
                    "version": 6
                }
            ]
        }, 
        "created": "2012-08-16T18:41:43Z", 
        "flavor": {
            "id": "2", 
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/010101/flavors/2", 
                    "rel": "bookmark"
                }
            ]
        }, 
        "hostId": "33ccb6c82f3625748b6f2338f54d8e9df07cc583251e001355569056", 
        "id": "ef08aa7a-b5e4-4bb8-86df-5ac56230f841", 
        "image": {
            "id": "3afe97b2-26dc-49c5-a2cc-a2fc8d80c001", 
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/010101/images/3afe97b2-26dc-49c5-a2cc-a2fc8d80c001", 
                    "rel": "bookmark"
                }
            ]
        }, 
        "links": [
            {
                "href": "https://dfw.servers.api.rackspacecloud.com/v2/010101/servers/ef08aa7a-b5e4-4bb8-86df-5ac56230f841", 
                "rel": "self"
            }, 
            {
                "href": "https://dfw.servers.api.rackspacecloud.com/010101/servers/ef08aa7a-b5e4-4bb8-86df-5ac56230f841", 
                "rel": "bookmark"
            }
        ], 
        "metadata": {
            "My Server Name": "API Test Server 2",
            "OS-SI:image_schedule": {
                "retention": 7
            },
        }, 
        "name": "api-test-server 2", 
        "progress": 100, 
        "rax-bandwidth:bandwidth": [], 
        "status": "ACTIVE", 
        "tenant_id": "010101", 
        "updated": "2012-08-16T18:50:38Z", 
        "user_id": "170454"
    }
}

Sample server detail response (XML)

<?xml version='1.0' encoding='UTF-8'?>
<server
    xmlns:rax-bandwidth="http://docs.rackspace.com/servers/api/ext/server_bandwidth/"
    xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1"
    xmlns:OS-SI="http://docs.openstack.org/servers/api/ext/scheduled_images/v1.0"
    xmlns:OS-EXT-STS="http://docs.openstack.org/compute/ext/extended_status/api/v1.1"
    xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns="http://docs.openstack.org/compute/api/v1.1" status="BUILD"
    updated="2012-08-16T18:48:41Z"
    hostId="0b88822e7a5db46eb95b69c0608733904b2cd4f18b0c1e418eb06e1c"
    name="api-test-server-xml" created="2012-08-16T18:48:23Z"
    userId="170454" tenantId="010101" accessIPv4="" accessIPv6=""
    progress="25" id="0f828bfb-609c-4042-be41-6dcc1b76228f"
    OS-EXT-STS:vm_state="building" OS-EXT-STS:task_state="spawning"
    OS-EXT-STS:power_state="0" OS-DCF:diskConfig="AUTO">
    <image id="3afe97b2-26dc-49c5-a2cc-a2fc8d80c001">
        <atom:link
            href="https://dfw.servers.api.rackspacecloud.com/010101/images/3afe97b2-26dc-49c5-a2cc-a2fc8d80c001"
            rel="bookmark"/>
    </image>
    <flavor id="2">
        <atom:link
            href="https://dfw.servers.api.rackspacecloud.com/010101/flavors/2"
            rel="bookmark"/>
    </flavor>
    <metadata>
        <meta key="My Server Name">API Test Server XML</meta>
        <meta key="OS-SI:image_schedule"><retention>7</retention></meta>
    </metadata>
    <addresses>
        <network id="public">
            <ip version="6"
                addr="2001:4800:780e:0510:d87b:9cbc:ff04:5146"/>
            <ip version="4" addr="198.101.242.212"/>
        </network>
        <network id="private">
            <ip version="4" addr="10.180.15.103"/>
        </network>
    </addresses>
    <atom:link
        href="https://dfw.servers.api.rackspacecloud.com/v2/010101/servers/0f828bfb-609c-4042-be41-6dcc1b76228f"
        rel="self"/>
    <atom:link
        href="https://dfw.servers.api.rackspacecloud.com/010101/servers/0f828bfb-609c-4042-be41-6dcc1b76228f"
        rel="bookmark"/>
    <rax-bandwidth:bandwidth/>
</server>

Additional Query Parameter on List Servers Requests

This extension introduces an additional query parameter for the two Nova list servers requests to filter responses to include either only servers that have an image_schedule resource set on them (or only servers that do not have the image_schedule resource set). 


GET /{tenantId}/servers?OS-SI:image-schedule={boolean}
GET /{tenantId}/servers/detail?OS-SI:image-schedule={boolean}


The {boolean} value is either the keyword `true` or `false`. If it's `true`, then only those servers containing an `image_schedule` resource are included in the list, if it's `false`, only those servers without an `image_schedule` resource are included in the listing.

Sample Extension Query Responses

Extension Query Response: XML

<?xml version="1.0" encoding="UTF-8"?>

<extensions xmlns="http://docs.openstack.org/common/api/v1.0"
            xmlns:atom="http://www.w3.org/2005/Atom">
    <extension name="Scheduled Images Extension"
               namespace="http://docs.openstack.org/servers/api/ext/scheduled_images/v1.0"
               alias="OS-SI" updated="2013-01-11T16:40:00-04:00">
        <description>
            Enables automatic daily images to be taken of a server.
        </description>
        <atom:link rel="describedby" type="application/pdf"
                   href="http://docs.openstack.org/servers/api/ext/scheduled_images.pdf"/>
        <atom:link rel="describedby" type="application/xml"
                   href="http://docs.openstack.org/servers/api/ext/scheduled_images/scheduled_images.wadl"/>
    </extension>
</extensions>

Extension Query Response: JSON

{
    "extensions": [
        {
            "name": "Scheduled Images Extension",
            "namespace": "http://docs.openstack.org/servers/api/ext/scheduled_images/v1.0",
            "alias": "OS-SI",
            "updated": "2013-01-11T16:40:00-04:00",
            "description": "Enables automatic daily images to be taken of a server.",
            "links": [
                {
                    "rel": "describedby",
                    "type": "application/pdf",
                    "href": "http://docs.openstack.org/servers/api/ext/scheduled_images.pdf"
                },
                {
                    "rel": "describedby",
                    "type": "application/xml",
                    "href": "http://docs.openstack.org/servers/api/ext/scheduled_images/scheduled_images.wadl"
                }
            ]
        }
    ]
}
Retrieved from "https://wiki.openstack.org/w/index.php?title=Nova-scheduled-images-extension&oldid=17941"