diff options
| author | Julia Kreger <juliaashleykreger@gmail.com> | 2019-08-14 16:26:41 -0400 |
|---|---|---|
| committer | Julia Kreger <juliaashleykreger@gmail.com> | 2019-08-20 21:51:12 +0000 |
| commit | f62758cda5953ac22614a783df0165e42e76d60b (patch) | |
| tree | e5652a8b0c6032d7430a913ac8810383c50397cb /doc/source | |
| parent | e3b07919415e97b92a892d434a950b0e32027717 (diff) | |
| download | python-ironicclient-f62758cda5953ac22614a783df0165e42e76d60b.tar.gz | |
Remove the ironic command
The ironic command is dead, long live the OSC baremetal command.
Also removed the json_respose tests, which seemed ot be geared
to checking json returned data on the command line. For ironic
these tests seemed to be very explicit for our CLI where as OSC
should be covering the return data handling, the only real end
effect is field level expectation enforcement in the functional
test... which seems excessive and un-needed.
Story: 1726605
Task: 11974
Depends-on: https://review.opendev.org/677183
Change-Id: I3e3ae416a65d8e01956434ba51bd3187ab001f80
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/cli/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/cli/ironic_client.rst | 100 | ||||
| -rw-r--r-- | doc/source/index.rst | 3 | ||||
| -rw-r--r-- | doc/source/user/create_command.rst | 22 |
4 files changed, 3 insertions, 123 deletions
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index b4f306f..ac8ad07 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -5,4 +5,3 @@ python-ironicclient User Documentation .. toctree:: osc_plugin_cli - ironic_client diff --git a/doc/source/cli/ironic_client.rst b/doc/source/cli/ironic_client.rst deleted file mode 100644 index 7ee6b5e..0000000 --- a/doc/source/cli/ironic_client.rst +++ /dev/null @@ -1,100 +0,0 @@ -======================================= -``ironic`` Command-Line Interface (CLI) -======================================= - -.. program:: ironic -.. highlight:: bash - -SYNOPSIS -======== - -:program:`ironic` [options] <command> [command-options] - -:program:`ironic help` - -:program:`ironic help` <command> - - -DESCRIPTION -=========== - -.. WARNING:: - - The :program:`ironic` command-line interface is deprecated; no new features - will be added. This CLI will be removed in the S* release. The `openstack - baremetal <osc_plugin_cli>`_ command-line interface should be used instead. - -The :program:`ironic` command-line interface (CLI) interacts with the -OpenStack Bare Metal Service (Ironic). - -In order to use the CLI, you must provide your OpenStack username, password, -project (historically called tenant), and auth endpoint. You can use -configuration options ``--os-username``, ``--os-password``, -``--os-tenant-id`` (or ``--os-tenant-name``), -and ``--os-auth-url``, or set the corresponding -environment variables:: - - $ export OS_USERNAME=user - $ export OS_PASSWORD=password - $ export OS_PROJECT_ID=b363706f891f48019483f8bd6503c54b # or OS_PROJECT_NAME - $ export OS_PROJECT_NAME=project # or OS_PROJECT_ID - $ export OS_AUTH_URL=http://auth.example.com:5000/v2.0 - -The command-line tool will attempt to reauthenticate using the provided -credentials for every request. You can override this behavior by manually -supplying an auth token using ``--ironic-url`` and -``--os-auth-token``, or by setting the corresponding environment -variables:: - - $ export IRONIC_URL=http://ironic.example.org:6385/ - $ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 - -Since Keystone can return multiple regions in the Service Catalog, you can -specify the one you want with ``--os-region-name`` or set the following -environment variable. (It defaults to the first in the list returned.) -:: - - export OS_REGION_NAME=region - -Ironic CLI supports bash completion. The command-line tool can automatically -fill partially typed commands. To use this feature, source the below file -(available at -https://opendev.org/openstack/python-ironicclient/src/branch/master/tools/ironic.bash_completion) -to your terminal and then bash completion should work:: - - $ . ironic.bash_completion - -To avoid doing this every time, add this to your ``.bashrc`` or copy the -ironic.bash_completion file to the default bash completion scripts directory -on your linux distribution. - -OPTIONS -======= - -To get a list of available (sub)commands and options, run:: - - $ ironic help - -To get usage and options of a command, run:: - - $ ironic help <command> - - -EXAMPLES -======== - -Get information about the node-create command:: - - $ ironic help node-create - -Get a list of available drivers:: - - $ ironic driver-list - -Enroll a node with the ``ipmi`` driver, specifying the IPMI address:: - - $ ironic node-create -d ipmi -i ipmi_address=1.2.3.4 - -Get a list of nodes:: - - $ ironic node-list diff --git a/doc/source/index.rst b/doc/source/index.rst index cc14818..67dc6ee 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,8 +5,7 @@ Python Bindings to the OpenStack Ironic API This is a client for the OpenStack `Ironic`_ API. It provides: * a Python API: the ``ironicclient`` module, and -* two command-line interfaces: ``openstack baremetal`` and ``ironic`` - (deprecated, please use ``openstack baremetal`` instead). +* command-line interface: ``openstack baremetal`` Contents ======== diff --git a/doc/source/user/create_command.rst b/doc/source/user/create_command.rst index ed5fe3d..5396dad 100644 --- a/doc/source/user/create_command.rst +++ b/doc/source/user/create_command.rst @@ -3,7 +3,7 @@ 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: +or YAML format. It can be done in one of two ways: 1. Using OpenStackClient bare metal plugin CLI's command ``openstack baremetal create``:: @@ -17,25 +17,7 @@ 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 ironic CLI's ``ironic create`` command (deprecated, please use - ``openstack baremetal create`` instead):: - - $ ironic help create - The "ironic" CLI is deprecated and will be removed in the S* release. - Please use the "openstack baremetal" CLI instead. - usage: ironic create <file> [<file> ...] - - Create baremetal resources (chassis, nodes, port groups and ports). The - resources may be described in one or more JSON or YAML files. If any file - cannot be validated, no resources are created. An attempt is made to - create all the resources; those that could not be created are skipped - (with a corresponding error message). - - Positional arguments: - <file> File (.yaml or .json) containing descriptions of the resources - to create. Can be specified multiple times. - -3. Programmatically using the Python API: +2. Programmatically using the Python API: .. autofunction:: ironicclient.v1.create_resources.create_resources :noindex: |
