summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBrant Knudson <bknudson@us.ibm.com>2014-10-10 18:55:59 -0500
committerBrant Knudson <bknudson@us.ibm.com>2014-10-12 10:44:36 -0500
commitab60065f5a8f2eaf19bba946310ab712f48edcfd (patch)
tree148328c80c2882aae03218f355b62a6ef3a08103 /doc
parent89dc951f7d5a603f0c34b7c2cb9f7d26d73d9916 (diff)
downloadpython-keystoneclient-ab60065f5a8f2eaf19bba946310ab712f48edcfd.tar.gz
Warn that keystone CLI is pending deprecation
The keystone CLI is pending deprecation so warn about it in the developer docs. DocImpact Change-Id: Ibca9d4cd8d31a62ee1ec7f24671c8f0f01ca9f7f
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 d96d89f..8bf979f 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).