summaryrefslogtreecommitdiff
path: root/doc/source/user/create_command.rst
diff options
context:
space:
mode:
authorRuby Loo <ruby.loo@intel.com>2017-09-27 12:41:28 -0400
committerRuby Loo <ruby.loo@intel.com>2017-10-03 10:12:29 -0400
commitad1fe203b028f0d90ab5ac535f159c6a822af2a4 (patch)
tree82151fedfa08f058812a7a213ff01f29e4032854 /doc/source/user/create_command.rst
parent55864c9c9580cf125a2fe59b933ea7ac58dd56bb (diff)
downloadpython-ironicclient-ad1fe203b028f0d90ab5ac535f159c6a822af2a4.tar.gz
Update documentation
This updates the documentation. Changes include: - putting 'openstack baremetal' commands before 'ironic' commands, since the plan is to deprecate the 'ironic' CLI - fixing formatting issues - removing the description for the 'openstack baremetal create' command about how it can be used for creating a node -- this functionality has been deleted. - in the examples, using hardware types instead of classic drivers, since the plan is to deprecate classic drivers Change-Id: I09fdf160122664d923361a8a8c80c61aba347c30
Diffstat (limited to 'doc/source/user/create_command.rst')
-rw-r--r--doc/source/user/create_command.rst49
1 files changed, 15 insertions, 34 deletions
diff --git a/doc/source/user/create_command.rst b/doc/source/user/create_command.rst
index ec966c9..486afb2 100644
--- a/doc/source/user/create_command.rst
+++ b/doc/source/user/create_command.rst
@@ -5,7 +5,19 @@ Creating the Bare Metal service resources from file
It is possible to create a set of resources using their descriptions in JSON
or YAML format. It can be done in one of three ways:
-1. Using ironic CLI's ``ironic create`` command::
+1. Using OpenStackClient bare metal plugin CLI's command ``openstack baremetal
+ create``::
+
+ $ openstack -h baremetal create
+ usage: openstack baremetal create [-h] <file> [<file> ...]
+
+ Create resources from files
+
+ positional arguments:
+ <file> File (.yaml or .json) containing descriptions of the
+ resources to create. Can be specified multiple times.
+
+2. Using ironic CLI's ``ironic create`` command::
$ ironic help create
usage: ironic create <file> [<file> ...]
@@ -20,41 +32,10 @@ or YAML format. It can be done in one of three ways:
<file> File (.yaml or .json) containing descriptions of the resources
to create. Can be specified multiple times.
-2. Using openstackclient plugin command ``openstack baremetal create``::
-
- $ openstack -h baremetal create
- usage: openstack [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
- [--max-width <integer>] [--noindent] [--prefix PREFIX]
- [--chassis-uuid <chassis>] [--driver-info <key=value>]
- [--property <key=value>] [--extra <key=value>]
- [--uuid <uuid>] [--name <name>]
- [--network-interface <network_interface>]
- [--resource-class <resource_class>] [--driver <driver>]
- [<file> [<file> ...]]
-
- Create resources from files or Register a new node (DEPRECATED). Create
- resources from files (by only specifying the files) or register a new
- node by specifying one or more optional arguments (DEPRECATED, use
- 'openstack baremetal node create' instead).
-
- positional arguments:
- <file> File (.yaml or .json) containing descriptions of
- the resources to create. Can be specified
- multiple times. If you want to create resources,
- only specify the files. Do not specify any of
- the optional arguments.
-
- .. note::
- If the ``--driver`` argument is passed in, the behaviour of the command
- is the same as ``openstack baremetal node create``, and positional
- arguments are ignored. If it is not provided, the command does resource
- creation from file(s), and only positional arguments will be taken into
- account.
-
3. Programmatically using the Python API:
- .. autofunction:: ironicclient.v1.create_resources.create_resources
- :noindex:
+ .. autofunction:: ironicclient.v1.create_resources.create_resources
+ :noindex:
File containing Resource Descriptions
=====================================