summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorRuby Loo <ruby.loo@intel.com>2017-09-28 12:14:12 -0400
committerRuby Loo <ruby.loo@intel.com>2017-10-11 10:03:26 -0400
commit8c58b75e050395d622c791830ceedbb06b96a327 (patch)
tree9b50dca2a46cf84fce98989c3254883099bf41bb /README.rst
parentad1fe203b028f0d90ab5ac535f159c6a822af2a4 (diff)
downloadpython-ironicclient-8c58b75e050395d622c791830ceedbb06b96a327.tar.gz
Deprecate the ironic CLI
The 'ironic' CLI is being deprecated; it is slated for removal in the S* release cycle. The 'openstack baremetal' CLI should be used instead. A message is printed out to that effect and the documentation is updated to reflect this. Change-Id: Ie6ac3c6222ec6a6231b9a9cb2949cac56b48967f Closes-Bug: 1700815
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index a85b9b8..54157a3 100644
--- a/README.rst
+++ b/README.rst
@@ -14,7 +14,8 @@ This is a client for the OpenStack `Ironic
<https://wiki.openstack.org/wiki/Ironic>`_ API. It provides:
* a Python API: the ``ironicclient`` module, and
-* two command-line interfaces: ``openstack baremetal`` and ``ironic``.
+* two command-line interfaces: ``openstack baremetal`` and ``ironic``
+ (deprecated, please use ``openstack baremetal``).
Development takes place via the usual OpenStack processes as outlined in the
`developer guide <https://docs.openstack.org/infra/manual/developers.html>`_.
@@ -74,8 +75,11 @@ the subcommands available, run::
$ openstack help baremetal
-``ironic`` CLI
---------------
+``ironic`` CLI (deprecated)
+---------------------------
+
+This is deprecated and will be removed in the S* release. Please use the
+``openstack baremetal`` CLI instead.
This package will install the ``ironic`` command line interface that you
can use to interact with the ``ironic`` API.