From 0901727da8ce4f1f6cf0b3f661b75d28ac480565 Mon Sep 17 00:00:00 2001
From: Dean Troyer <dtroyer@gmail.com>
Date: Mon, 16 May 2016 16:14:26 -0500
Subject: [PATCH] Add transition doc

Change-Id: Ie97f95a97caa0d06a115852bd4f4559c7b225994
---
 doc/source/index.rst      |  7 ++++
 doc/source/transition.rst | 88 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 95 insertions(+)
 create mode 100644 doc/source/transition.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 3cc59b1..642f1c6 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -5,6 +5,13 @@ osc-lib -- OpenStackClient Plugin Library
 OpenStackClient (aka OSC) is a command-line client for OpenStack.  osc-lib
 is a package of common support modules for writing OSC plugins.
 
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+
+   transition
+
 Contributing
 ============
 
diff --git a/doc/source/transition.rst b/doc/source/transition.rst
new file mode 100644
index 0000000..ed0e4c9
--- /dev/null
+++ b/doc/source/transition.rst
@@ -0,0 +1,88 @@
+===============================
+Transition from OpenStackClient
+===============================
+
+``osc-lib`` was extracted from the main OpenStackClient repo after the
+OSC 2.4.0 release.  During the migration all module names have changed
+from ``openstackclient.*`` to ``osc_lib.*``.  In addition, some re-arranging
+has been done internally to better align modules.
+
+The complete list of public module name changes:
+
+* ``openstackclient.i18n`` -> ``osc_lib.i18n``
+* ``openstackclient.common.command`` -> ``osc_lib.command.command``
+* ``openstackclient.common.commandmanager`` -> ``osc_lib.command.commandmanager``
+* ``openstackclient.common.exceptions`` -> ``osc_lib.exceptions``
+* ``openstackclient.common.logs`` -> ``osc_lib.logs``
+* ``openstackclient.common.parseractions`` -> ``osc_lib.cli.parseractions``
+* ``openstackclient.common.session`` -> ``osc_lib.session``
+* ``openstackclient.common.utils`` -> ``osc_lib.utils``
+* ``openstackclient.tests.fakes`` -> ``osc_lib.tests.fakes``
+* ``openstackclient.tests.utils`` -> ``osc_lib.tests.utils``
+
+Additional Changes
+==================
+
+In addition to the existing public modules, other parts of OSC have been
+extracted, including the base ``Command``, ``CommandManager``, ``ClientManager``
+and ``Session`` classes.
+
+ClientManager
+-------------
+
+The OSC ``ClientManager`` is responsible for managing all of the handles to the
+individual API client objects as well as coordinating session and authentication
+objects.
+
+Plugins are encouraged to use the ClientManager interface for obtaining information
+about global configuration.
+
+* ``openstackclient.common.clientmanager`` -> ``osc_lib.clientmanager``
+* All of the handling of the ``verify``/``insecure``/``cacert`` configuration
+  options has been consolidated into ``ClientManager``.  This converts the ``--verify``,
+  ``--insecure`` and ``--os-cacert`` options into a ``Requests``-compatible
+  ``verify`` attribute and a ``cacert`` attribute for the legacy client libraries.
+  both are now public; the ``_insecure`` attribute has been removed.
+
+.. list-table:: Verify/Insecure/CACert
+   :header-rows: 1
+
+   * - --verify
+     - --insecure
+     - --cacert
+     - Result
+   * - None
+     - None
+     -
+     - ``verify=True``, ``cacert=None``
+   * - True
+     - None
+     - None
+     - ``verify=True``, ``cacert=None``
+   * - None
+     - True
+     - None
+     - ``verify=False``, ``cacert=None``
+   * - None
+     - None
+     - <filename>
+     - ``verify=cacert``, ``cacert=<filename>``
+   * - True
+     - None
+     - <filename>
+     - ``verify=cacert``, ``cacert=<filename>``
+   * - None
+     - True
+     - <filename>
+     - ``verify=False``, ``cacert=None``
+
+* A number of other ``ClientManager`` attributes have also been made public to
+  encourage their direct use rather than reaching in to the global options passed
+  in the the ``ClientManager`` constructor:
+
+  * ``_verify`` -> ``verify``
+  * ``_cacert`` -> ``cacert``
+  * ``_cert`` -> ``cert``
+  * ``_insecure`` -> removed, use '`not verify'`
+  * ``_interface`` -> ``interface``
+  * ``_region_name`` -> ``region_name``