From 0468c79d72bd5fe08b58556e4228f84195bf2a67 Mon Sep 17 00:00:00 2001 From: namrata Date: Tue, 14 Aug 2018 19:05:01 +0000 Subject: [PATCH] Doc: Add appcontainer image delete, appcontainer image search and appcontainer image pull 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 --- doc/source/cli/command-objects/image.rst | 156 +++++++++++++++++++++++ 1 file changed, 156 insertions(+) diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst index da8578b5..c916eb0b 100644 --- a/doc/source/cli/command-objects/image.rst +++ b/doc/source/cli/command-objects/image.rst @@ -137,3 +137,159 @@ Describe a specific image .. 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] + +.. describe:: + + UUID of image to describe + +.. describe:: + + 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 ] + [--fit-width] [--print-empty] + [--noindent] [--prefix PREFIX] + + +.. describe:: + + Name of the image + +.. describe:: + + 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 + + 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 ] + [--fit-width] [--print-empty] + [--noindent] + [--quote {all,minimal,none,nonnumeric}] + [--sort-column SORT_COLUMN] + [--image-driver ] + [--exact-match] + + +.. describe:: + + Name of the image + +.. option:: -h, --help + + show this help message and exit + +.. option:: --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 + + 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