summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2014-12-02 00:02:50 +0000
committerGerrit Code Review <review@openstack.org>2014-12-02 00:02:50 +0000
commit29049f65654d4a7f057cab438bb9152900ee58db (patch)
tree6a2fc72f9fe46a673b760053b55e3547fff8d545 /doc
parent796c78a9b081bad18604bf0f2721e2cca869728b (diff)
parentab60065f5a8f2eaf19bba946310ab712f48edcfd (diff)
downloadpython-keystoneclient-29049f65654d4a7f057cab438bb9152900ee58db.tar.gz
Merge "Warn that keystone CLI is pending deprecation"
Diffstat (limited to 'doc')
-rw-r--r--doc/source/man/keystone.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/source/man/keystone.rst b/doc/source/man/keystone.rst
index 506fc2b..10d9d93 100644
--- a/doc/source/man/keystone.rst
+++ b/doc/source/man/keystone.rst
@@ -1,6 +1,6 @@
-========================================
-:program:`keystone` command line utility
-========================================
+==============================================================
+:program:`keystone` command line utility (pending deprecation)
+==============================================================
.. program:: keystone
.. highlight:: bash
@@ -18,6 +18,14 @@ SYNOPSIS
DESCRIPTION
===========
+.. WARNING::
+
+ The :program:`keystone` command line utility is pending deprecation. The
+ `OpenStackClient unified command line utility
+ <http://docs.openstack.org/developer/python-openstackclient/>`_ should be
+ used instead. The :program:`keystone` command line utility only supports V2
+ of the Identity API whereas the OSC program supports both V2 and V3.
+
The :program:`keystone` command line utility interacts with services providing
OpenStack Identity API (e.g. Keystone).