Curl examples from the Image API v2 document should go in User Guide

[Anne Gentle]

Appendix A: cURL Examples
=========================

This section is intended to provide a series of commands a typical
client of the API might use to create and modify an image.

These commands assume the implementation of the v2 Images API is using
the OpenStack Identity Service for authentication and authorization. The
X-Auth-Token header is used to communicate the authentication token
provided by that separate identity service.

The strings ``$OS_IMAGE_URL`` and ``$OS_AUTH_TOKEN`` represent variables
defined in the client's environment. ``$OS_IMAGE_URL`` is the full path
to your image service endpoint, for example, ``http://localhost:9292``.
``$OS_AUTH_TOKEN`` represents an auth token generated by the OpenStack
Identity Service, for example, ``6583fb17c27b48b4b4a6033fe9cc0fe0``.

Create an Image
---------------

::

    % curl -i -X POST -H "X-Auth-Token: $OS_AUTH_TOKEN" \
           -H "Content-Type: application/json" \
           -d '{"name": "Ubuntu 12.10", "tags": ["ubuntu", "12.10", "quantal"]}' \
           $OS_IMAGE_URL/v2/images

::

    HTTP/1.1 201 Created
    Content-Length: 451
    Content-Type: application/json; charset=UTF-8
    Location: http://localhost:9292/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad
    Date: Tue, 14 Aug 2012 00:46:48 GMT

    {
        "id": "7b97f37c-899d-44e8-aaa0-543edbc4eaad",
        "name": "Ubuntu 12.10",
        "status": "queued",
        "visibility": "private",
        "protected": false,
        "tags": ["ubuntu", "12.10", "quantal"],
        "created_at": "2012-08-14T00:46:48Z",
        "updated_at": "2012-08-14T00:46:48Z",
        "file": "/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad/file",
        "self": "/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad",
        "schema": "/v2/schemas/image"
    }

Update the Image
----------------

::

    % curl -i -X PATCH -H "X-Auth-Token: $OS_AUTH_TOKEN" \
           -H "Content-Type: application/openstack-images-v2.1-json-patch"
           -d '[{"op": "add", "path": "/login-user", "value": "root"}]' \
           $OS_IMAGE_URL/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad

::

    HTTP/1.1 200 OK
    Content-Length: 477
    Content-Type: application/json; charset=UTF-8
    Date: Fri, 15 Nov 2013 00:46:50 GMT

    {
        "id": "7b97f37c-899d-44e8-aaa0-543edbc4eaad",
        "name": "Ubuntu 12.10",
        "status": "queued",
        "visibility": "private",
        "protected": false,
        "tags": ["ubuntu", "12.10", "quantal"],
        "login_user": "root",
        "created_at": "2013-11-15T00:46:48Z",
        "updated_at": "2013-11-15T00:46:50Z",
        "file": "/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad/file",
        "self": "/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad",
        "schema": "/v2/schemas/image"
    }

Upload Binary Image Data
------------------------

::

    % curl -i -X PUT -H "X-Auth-Token: $OS_AUTH_TOKEN" \
           -H "Content-Type: application/octet-stream" \
           -d @/home/glance/ubuntu-12.10.qcow2 \
           $OS_IMAGE_URL/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad/file

::

    HTTP/1.1 100 Continue

    HTTP/1.1 201 Created
    Content-Length: 0
    Date: Tue, 14 Aug 2012 00:46:59 GMT

Download Binary Image Data
--------------------------

::

    % curl -i -X GET -H "X-Auth-Token: $OS_AUTH_TOKEN" \
           $OS_IMAGE_URL/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad/file

::

    HTTP/1.1 200 OK
    Content-Type: application/octet-stream
    Content-Md5: 912ec803b2ce49e4a541068d495ab570
    Transfer-Encoding: chunked
    Date: Thu, 14 Aug 2012 00:47:10 GMT

Delete Image
------------

::

    % curl -i -X DELETE -H "X-Auth-Token: $OS_AUTH_TOKEN" \
           $OS_IMAGE_URL/v2/images/7b97f37c-899d-44e8-aaa0-543edbc4eaad

::

    HTTP/1.1 204 No Content
    Content-Length: 0
    Date: Tue, 14 Aug 2012 00:47:12 GMT

[Njira Perci (njirap)]

Hi Tom and Anne.. Is the bug description supposed to be copy pasted as in to the user-guide..?

[Anne Gentle (annegentle)]

Yes, if it is tested and still works. There's lots of confusion about the glance calls lately so it would be nice to clear it up.

We brought in curl examples for the Object Storage API, here are some examples: http://docs.openstack.org/user-guide/cli_swift_large_lists.html
http://docs.openstack.org/user-guide/cli_swift_pseudo_hierarchical_folders_directories.html

so try to find a good place for these create/update/upload/delete tasks.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/291705

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/292361

[OpenStack Infra (hudson-openstack)]

Change abandoned by Sharat Sharma (<email address hidden>) on branch: master
Review: https://review.openstack.org/292361
Reason: Abondoning as change not significant.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/292711

[OpenStack Infra (hudson-openstack)]

Change abandoned by Sharat Sharma (<email address hidden>) on branch: master
Review: https://review.openstack.org/292711
Reason: Duplicate

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/298211

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/298633

[OpenStack Infra (hudson-openstack)]

Change abandoned by Sharat Sharma (<email address hidden>) on branch: master
Review: https://review.openstack.org/298211

[OpenStack Infra (hudson-openstack)]

Change abandoned by Sharat Sharma (<email address hidden>) on branch: master
Review: https://review.openstack.org/291705
Reason: https://review.openstack.org/#/c/298633/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/298633
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=bc4d9ddb1ec92b2da37fa86da3667bb15245b974
Submitter: Jenkins
Branch: master

commit bc4d9ddb1ec92b2da37fa86da3667bb15245b974
Author: sharat.sharma <email address hidden>
Date: Tue Mar 29 15:26:32 2016 +0530

    [user-guide] Added cURL examples to manage images from cli.

    Change-Id: I00d76586f083cd8c131e3264558148f641cdb75f
    Closes-Bug: #1399814

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.