0468c79d72
Add command list documentation for the 'appcontainer image delete', 'appcontainer image search' and 'appcontainer image pull' commands. Partially Implements: blueprint zun-cli-guide Change-Id: Ie4f6e071471e4b0fd1a3dbec69945f9a7a5bfe8d
296 lines
7.5 KiB
ReStructuredText
296 lines
7.5 KiB
ReStructuredText
==================
|
|
appcontainer image
|
|
==================
|
|
|
|
An **appcontainer image** specifies the image for a host.
|
|
|
|
appcontainer image list
|
|
-----------------------
|
|
|
|
List available images
|
|
|
|
.. program:: appcontainer image list
|
|
.. code:: bash
|
|
|
|
openstack appcontainer image list [-h] [-f {csv,json,table,value,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--fit-width] [--print-empty]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--sort-column SORT_COLUMN]
|
|
[--marker <marker>] [--limit <limit>]
|
|
[--sort-key <sort-key>]
|
|
[--sort-dir <sort-dir>]
|
|
|
|
.. option:: -h, --help
|
|
|
|
show this help message and exit
|
|
|
|
.. option:: --marker <marker>
|
|
|
|
The last host UUID of the previous page; displays list
|
|
of hosts after "marker".
|
|
|
|
.. option:: --limit <limit>
|
|
|
|
Maximum number of hosts to return
|
|
|
|
.. option:: --sort-key <sort-key>
|
|
|
|
Column to sort results by
|
|
|
|
.. option:: --sort-dir <sort-dir>
|
|
|
|
Direction to sort. "asc" or "desc".
|
|
|
|
.. option:: -f {csv,json,table,value,yaml},
|
|
--format {csv,json,table,value,yaml}
|
|
|
|
the output format, defaults to table
|
|
|
|
.. option:: -c COLUMN, --column COLUMN
|
|
|
|
specify the column(s) to include, can be repeated
|
|
|
|
.. option:: --sort-column SORT_COLUMN
|
|
|
|
specify the column(s) to sort the data (columns
|
|
specified first have a priority, non-existing columns
|
|
are ignored), can be repeated
|
|
|
|
.. option:: --max-width <integer>
|
|
|
|
Maximum display width, <1 to disable. You can also use
|
|
the CLIFF_MAX_TERM_WIDTH environment variable, but the
|
|
parameter takes precedence.
|
|
|
|
.. option:: --fit-width
|
|
|
|
Fit the table to the display width. Implied if --max-
|
|
width greater than 0. Set the environment variable
|
|
CLIFF_FIT_WIDTH=1 to always enable
|
|
|
|
.. option:: --print-empty
|
|
|
|
Print empty table if there is no data to show.
|
|
|
|
.. option:: --noindent
|
|
|
|
whether to disable indenting the JSON
|
|
|
|
.. option:: --quote {all,minimal,none,nonnumeric}
|
|
|
|
when to include quotes, defaults to nonnumeric
|
|
|
|
appcontainer image show
|
|
-----------------------
|
|
|
|
Describe a specific image
|
|
|
|
.. program:: appcontainer image show
|
|
.. code:: bash
|
|
|
|
openstack appcontainer image show [-h]
|
|
[-f {json,shell,table,value,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--fit-width] [--print-empty]
|
|
[--noindent] [--prefix PREFIX]
|
|
<uuid>
|
|
|
|
.. describe:: <uuid>
|
|
|
|
UUID of image to describe
|
|
|
|
.. option:: -h, --help
|
|
|
|
show this help message and exit
|
|
|
|
.. option:: -f {json,shell,table,value,yaml},
|
|
--format {json,shell,table,value,yaml}
|
|
|
|
the output format, defaults to table
|
|
|
|
.. option:: -c COLUMN, --column COLUMN
|
|
|
|
specify the column(s) to include, can be repeated
|
|
|
|
.. option:: --max-width <integer>
|
|
|
|
Maximum display width, <1 to disable. You can also use
|
|
the CLIFF_MAX_TERM_WIDTH environment variable, but the
|
|
parameter takes precedence.
|
|
|
|
.. option:: --fit-width
|
|
|
|
Fit the table to the display width. Implied if --max-
|
|
width greater than 0. Set the environment variable
|
|
CLIFF_FIT_WIDTH=1 to always enable
|
|
|
|
.. option:: --print-empty
|
|
|
|
Print empty table if there is no data to show.
|
|
|
|
.. option:: --noindent
|
|
|
|
whether to disable indenting the JSON
|
|
|
|
.. option:: --prefix PREFIX
|
|
|
|
add a prefix to all variable names
|
|
|
|
appcontainer image delete
|
|
-------------------------
|
|
|
|
Delete specified image from a host
|
|
|
|
.. program:: appcontainer image delete
|
|
.. code:: bash
|
|
|
|
openstack appcontainer image delete [-h] <uuid> <host>
|
|
|
|
.. describe:: <uuid>
|
|
|
|
UUID of image to describe
|
|
|
|
.. describe:: <host>
|
|
|
|
Name or UUID of the host
|
|
|
|
.. option:: -h, --help
|
|
|
|
show this help message and exit
|
|
|
|
appcontainer image pull
|
|
-----------------------
|
|
|
|
Pull specified image into a host
|
|
|
|
.. program:: appcontainer image pull
|
|
.. code:: bash
|
|
|
|
openstack appcontainer image pull [-h]
|
|
[-f {json,shell,table,value,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--fit-width] [--print-empty]
|
|
[--noindent] [--prefix PREFIX]
|
|
<image> <host>
|
|
|
|
.. describe:: <image>
|
|
|
|
Name of the image
|
|
|
|
.. describe:: <host>
|
|
|
|
Name or UUID of the host
|
|
|
|
.. option:: -h, --help
|
|
|
|
show this help message and exit
|
|
|
|
.. option:: -f {json,shell,table,value,yaml},
|
|
--format {json,shell,table,value,yaml}
|
|
|
|
the output format, defaults to table
|
|
|
|
.. option:: -c COLUMN, --column COLUMN
|
|
|
|
specify the column(s) to include, can be repeated
|
|
|
|
.. option:: --max-width <integer>
|
|
|
|
Maximum display width, <1 to disable. You can also use
|
|
the CLIFF_MAX_TERM_WIDTH environment variable, but the
|
|
parameter takes precedence.
|
|
|
|
.. option:: --fit-width
|
|
|
|
Fit the table to the display width. Implied if --max-
|
|
width greater than 0. Set the environment variable
|
|
CLIFF_FIT_WIDTH=1 to always enable
|
|
|
|
.. option:: --print-empty
|
|
|
|
Print empty table if there is no data to show.
|
|
|
|
.. option:: --noindent
|
|
|
|
whether to disable indenting the JSON
|
|
|
|
.. option:: --prefix PREFIX
|
|
|
|
add a prefix to all variable names
|
|
|
|
appcontainer image search
|
|
-------------------------
|
|
|
|
Search the image repository for images
|
|
|
|
.. program:: appcontainer image search
|
|
.. code:: bash
|
|
|
|
openstack appcontainer image search [-h]
|
|
[-f {csv,json,table,value,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--fit-width] [--print-empty]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--sort-column SORT_COLUMN]
|
|
[--image-driver <image-driver>]
|
|
[--exact-match]
|
|
<image_name>
|
|
|
|
.. describe:: <image_name>
|
|
|
|
Name of the image
|
|
|
|
.. option:: -h, --help
|
|
|
|
show this help message and exit
|
|
|
|
.. option:: --image-driver <image-driver>
|
|
|
|
Name of the image driver
|
|
|
|
.. option:: --exact-match
|
|
|
|
exact match image name
|
|
|
|
.. option:: -f {csv,json,table,value,yaml},
|
|
--format {csv,json,table,value,yaml}
|
|
|
|
the output format, defaults to table
|
|
|
|
.. option:: -c COLUMN, --column COLUMN
|
|
|
|
specify the column(s) to include, can be repeated
|
|
|
|
.. option:: --sort-column SORT_COLUMN
|
|
|
|
specify the column(s) to sort the data (columns
|
|
specified first have a priority, non-existing columns
|
|
are ignored), can be repeated
|
|
|
|
.. option:: --max-width <integer>
|
|
|
|
Maximum display width, <1 to disable. You can also use
|
|
the CLIFF_MAX_TERM_WIDTH environment variable, but the
|
|
parameter takes precedence.
|
|
|
|
.. option:: --fit-width
|
|
|
|
Fit the table to the display width. Implied if --max-
|
|
width greater than 0. Set the environment variable
|
|
CLIFF_FIT_WIDTH=1 to always enable
|
|
|
|
.. option:: --print-empty
|
|
|
|
Print empty table if there is no data to show.
|
|
|
|
.. option:: --noindent
|
|
|
|
whether to disable indenting the JSON
|
|
|
|
.. option:: --quote {all,minimal,none,nonnumeric}
|
|
|
|
when to include quotes, defaults to nonnumeric
|