reorganize existing documentation according to the new standard layout

Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

1 files changed, 576 insertions, 0 deletions

diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst
new file mode 100644
index 00000000..ec51fa93
--- /dev/null
+++ b/doc/source/cli/command-objects/image.rst
@@ -0,0 +1,576 @@
+=====
+image
+=====
+
+Image v1, v2
+
+image add project
+-----------------
+
+*Only supported for Image v2*
+
+Associate project with image
+
+.. program:: image add project
+.. code:: bash
+
+    openstack image add project
+        [--project-domain <project-domain>]
+        <image> <project>
+
+.. option:: --project-domain <project-domain>
+
+    Domain the project belongs to (name or ID).
+    This can be used in case collisions between project names exist.
+
+.. _image_add_project-image:
+.. describe:: <image>
+
+    Image to share (name or ID).
+
+.. _image_add_project-project:
+.. describe:: <project>
+
+    Project to associate with image (name or ID)
+
+image create
+------------
+
+*Image v1, v2*
+
+Create/upload an image
+
+.. program:: image create
+.. code:: bash
+
+    openstack image create
+        [--id <id>]
+        [--store <store>]
+        [--container-format <container-format>]
+        [--disk-format <disk-format>]
+        [--size <size>]
+        [--min-disk <disk-gb>]
+        [--min-ram <ram-mb>]
+        [--location <image-url>]
+        [--copy-from <image-url>]
+        [--file <file> | --volume <volume>]
+        [--force]
+        [--checksum <checksum>]
+        [--protected | --unprotected]
+        [--public | --private]
+        [--property <key=value> [...] ]
+        [--tag <tag> [...] ]
+        [--project <project> [--project-domain <project-domain>]]
+        <image-name>
+
+.. option:: --id <id>
+
+    Image ID to reserve
+
+.. option:: --store <store>
+
+    Upload image to this store
+
+    *Image version 1 only.*
+
+.. option:: --container-format <container-format>
+
+    Image container format. The supported options are: ami, ari, aki,
+    bare, docker, ova, ovf. The default format is: bare
+
+.. option:: --disk-format <disk-format>
+
+    Image disk format. The supported options are: ami, ari, aki, vhd, vmdk,
+    raw, qcow2, vhdx, vdi, iso, and ploop. The default format is: raw
+
+.. option:: --size <size>
+
+    Image size, in bytes (only used with :option:`--location` and :option:`--copy-from`)
+
+    *Image version 1 only.*
+
+.. option:: --min-disk <disk-gb>
+
+    Minimum disk size needed to boot image, in gigabytes
+
+.. option:: --min-ram <ram-mb>
+
+    Minimum RAM size needed to boot image, in megabytes
+
+.. option:: --location <image-url>
+
+    Download image from an existing URL
+
+    *Image version 1 only.*
+
+.. option:: --copy-from <image-url>
+
+    Copy image from the data store (similar to :option:`--location`)
+
+    *Image version 1 only.*
+
+.. option:: --file <file>
+
+    Upload image from local file
+
+.. option:: --volume <volume>
+
+    Create image from a volume
+
+.. option:: --force
+
+    Force image creation if volume is in use (only meaningful with :option:`--volume`)
+
+.. option:: --checksum <checksum>
+
+    Image hash used for verification
+
+    *Image version 1 only.*
+
+.. option:: --protected
+
+    Prevent image from being deleted
+
+.. option:: --unprotected
+
+    Allow image to be deleted (default)
+
+.. option:: --public
+
+    Image is accessible to the public
+
+.. option:: --private
+
+    Image is inaccessible to the public (default)
+
+.. option:: --property <key=value>
+
+    Set a property on this image (repeat for multiple values)
+
+.. option:: --tag <tag>
+
+    Set a tag on this image (repeat for multiple values)
+
+    .. versionadded:: 2
+
+.. option:: --project <project>
+
+    Set an alternate project on this image (name or ID).
+    Previously known as `--owner`.
+
+.. option:: --project-domain <project-domain>
+
+    Domain the project belongs to (name or ID).
+    This can be used in case collisions between project names exist.
+
+    .. versionadded:: 2
+
+.. _image_create-image-name:
+.. describe:: <image-name>
+
+    New image name
+
+image delete
+------------
+
+Delete image(s)
+
+.. program:: image delete
+.. code:: bash
+
+    openstack image delete
+        <image>
+
+.. _image_delete-image:
+.. describe:: <image>
+
+    Image(s) to delete (name or ID)
+
+image list
+----------
+
+List available images
+
+.. program:: image list
+.. code:: bash
+
+    openstack image list
+        [--public | --private | --shared]
+        [--property <key=value>]
+        [--long]
+        [--sort <key>[:<direction>]]
+        [--limit <num-images>]
+        [--marker <image>]
+
+.. option:: --public
+
+    List only public images
+
+.. option:: --private
+
+    List only private images
+
+.. option:: --shared
+
+    List only shared images
+
+    *Image version 2 only.*
+
+.. option:: --property <key=value>
+
+    Filter output based on property
+
+.. option:: --long
+
+    List additional fields in output
+
+.. option:: --sort <key>[:<direction>]
+
+    Sort output by selected keys and directions(asc or desc) (default: name:asc),
+    multiple keys and directions can be specified separated by comma
+
+.. option:: --limit <num-images>
+
+    Maximum number of images to display.
+
+    *Image version 2 only*
+
+.. option:: --marker <image>
+
+    The last image of the previous page. Display list of images
+    after marker. Display all images if not specified. (name or ID)
+
+    *Image version 2 only*
+
+image remove project
+--------------------
+
+*Only supported for Image v2*
+
+Disassociate project with image
+
+.. program:: image remove project
+.. code:: bash
+
+    openstack image remove remove
+        [--project-domain <project-domain>]
+        <image>
+        <project>
+
+.. option:: --project-domain <project-domain>
+
+    Domain the project belongs to (name or ID).
+    This can be used in case collisions between project names exist.
+
+.. _image_remove_project:
+.. describe:: <image>
+
+    Image to unshare (name or ID).
+
+.. describe:: <project>
+
+    Project to disassociate with image (name or ID)
+
+image save
+----------
+
+Save an image locally
+
+.. program:: image save
+.. code:: bash
+
+    openstack image save
+        --file <filename>
+        <image>
+
+.. option:: --file <filename>
+
+    Downloaded image save filename (default: stdout)
+
+.. _image_save-image:
+.. describe:: <image>
+
+    Image to save (name or ID)
+
+image set
+---------
+
+*Image v1, v2*
+
+Set image properties
+
+.. program:: image set
+.. code:: bash
+
+    openstack image set
+        [--name <name>]
+        [--min-disk <disk-gb>]
+        [--min-ram <ram-mb>]
+        [--container-format <container-format>]
+        [--disk-format <disk-format>]
+        [--size <size>]
+        [--protected | --unprotected]
+        [--public | --private]
+        [--store <store>]
+        [--location <image-url>]
+        [--copy-from <image-url>]
+        [--file <file>]
+        [--volume <volume>]
+        [--force]
+        [--checksum <checksum>]
+        [--stdin]
+        [--property <key=value> [...] ]
+        [--tag <tag> [...] ]
+        [--architecture <architecture>]
+        [--instance-id <instance-id>]
+        [--kernel-id <kernel-id>]
+        [--os-distro <os-distro>]
+        [--os-version <os-version>]
+        [--ramdisk-id <ramdisk-id>]
+        [--activate|--deactivate]
+        [--project <project> [--project-domain <project-domain>]]
+        [--accept | --reject | --pending]
+        <image>
+
+.. option:: --name <name>
+
+    New image name
+
+.. option:: --min-disk <disk-gb>
+
+    Minimum disk size needed to boot image, in gigabytes
+
+.. option:: --min-ram <ram-mb>
+
+    Minimum RAM size needed to boot image, in megabytes
+
+.. option:: --container-format <container-format>
+
+    Image container format. The supported options are: ami, ari, aki,
+    bare, docker, ova, ovf.
+
+.. option:: --disk-format <disk-format>
+
+    Image disk format. The supported options are: ami, ari, aki, vhd, vmdk,
+    raw, qcow2, vhdx, vdi, iso, and ploop.
+
+.. option:: --size <size>
+
+    Size of image data (in bytes)
+
+    *Image version 1 only.*
+
+.. option:: --protected
+
+    Prevent image from being deleted
+
+.. option:: --unprotected
+
+    Allow image to be deleted (default)
+
+.. option:: --public
+
+    Image is accessible to the public
+
+.. option:: --private
+
+    Image is inaccessible to the public (default)
+
+.. option:: --store <store>
+
+    Upload image to this store
+
+    *Image version 1 only.*
+
+.. option:: --location <image-url>
+
+    Download image from an existing URL
+
+    *Image version 1 only.*
+
+.. option:: --copy-from <image-url>
+
+    Copy image from the data store (similar to :option:`--location`)
+
+    *Image version 1 only.*
+
+.. option:: --file <file>
+
+    Upload image from local file
+
+    *Image version 1 only.*
+
+.. option:: --volume <volume>
+
+    Update image with a volume
+
+    *Image version 1 only.*
+
+.. option:: --force
+
+    Force image update if volume is in use (only meaningful with :option:`--volume`)
+
+    *Image version 1 only.*
+
+.. option:: --checksum <checksum>
+
+    Image hash used for verification
+
+    *Image version 1 only.*
+
+.. option:: --stdin
+
+    Allow to read image data from standard input
+
+    *Image version 1 only.*
+
+.. option:: --property <key=value>
+
+    Set a property on this image (repeat option to set multiple properties)
+
+    .. versionadded:: 2
+
+.. option:: --tag <tag>
+
+    Set a tag on this image (repeat for multiple values)
+
+    .. versionadded:: 2
+
+.. option:: --architecture <architecture>
+
+    Operating system architecture
+
+    .. versionadded:: 2
+
+.. option:: --instance-id <instance-id>
+
+    ID of server instance used to create this image
+
+    .. versionadded:: 2
+
+.. option:: --kernel-id <kernel-id>
+
+    ID of kernel image used to boot this disk image
+
+    .. versionadded:: 2
+
+.. option:: --os-distro <os-distro>
+
+    Operating system distribution name
+
+    .. versionadded:: 2
+
+.. option:: --os-version <os-version>
+
+    Operating system distribution version
+
+    .. versionadded:: 2
+
+.. option:: --ramdisk-id <ramdisk-id>
+
+    ID of ramdisk image used to boot this disk image
+
+    .. versionadded:: 2
+
+.. option:: --activate
+
+    Activate the image.
+
+    .. versionadded:: 2
+
+.. option:: --deactivate
+
+    Deactivate the image.
+
+    .. versionadded:: 2
+
+.. option:: --project <project>
+
+    Set an alternate project on this image (name or ID).
+    Previously known as `--owner`.
+
+.. option:: --project-domain <project-domain>
+
+    Domain the project belongs to (name or ID).
+    This can be used in case collisions between project names exist.
+
+    .. versionadded:: 2
+
+.. option:: --accept
+
+    Accept the image membership.
+
+    If `--project` is passed, this will update the membership status for the
+    given project, otherwise `--project` will default to the project the user
+    is authenticated to.
+
+    .. versionadded:: 2
+
+.. option:: --reject
+
+    Reject the image membership.
+
+    If `--project` is passed, this will update the membership status for the
+    given project, otherwise `--project` will default to the project the user
+    is authenticated to.
+
+    .. versionadded:: 2
+
+.. option:: --pending
+
+    Reset the image membership to 'pending'.
+
+    If `--project` is passed, this will update the membership status for the
+    given project, otherwise `--project` will default to the project the user
+    is authenticated to.
+
+    .. versionadded:: 2
+
+.. _image_set-image:
+.. describe:: <image>
+
+    Image to modify (name or ID)
+
+image show
+----------
+
+Display image details
+
+.. program:: image show
+.. code:: bash
+
+    openstack image show
+        <image>
+
+.. _image_show-image:
+.. describe:: <image>
+
+    Image to display (name or ID)
+
+image unset
+-----------
+
+*Only supported for Image v2*
+
+Unset image tags or properties
+
+.. program:: image unset
+.. code:: bash
+
+    openstack image set
+        [--tag <tag>]
+        [--property <property>]
+        <image>
+
+.. option:: --tag <tag>
+
+    Unset a tag on this image (repeat option to unset multiple tags)
+
+.. option:: --property <property>
+
+    Unset a property on this image (repeat option to unset multiple properties)
+
+.. _image_unset-image:
+.. describe:: <image>
+
+    Image to modify (name or ID)