Rename keystore key-management

Service type will be key-manager, but service in the SDK will be key_management. Change-Id: Ied4d98f356f2b80a7c4cfc38a2af95052deb34c0 Closes-Bug: #1420461
2015-06-02 12:25:51 -06:00
parent c1b6b903d5
commit daaf606b72
27 changed files with 120 additions and 114 deletions
--- a/doc/source/users/index.rst
+++ b/doc/source/users/index.rst
@@ -31,7 +31,7 @@ approach, this is where you'll want to begin.
   Database <userguides/database>
   Identity <userguides/identity>
   Image <userguides/image>
-   Keystore <userguides/keystore>
+   Key Management <userguides/key_management>
   Metric <userguides/metric>
   Network <userguides/network>
   Object Store <userguides/object_store>
@@ -80,7 +80,7 @@ but listed below are the ones provided by this SDK by default.
   Database <proxies/database>
   Identity <proxies/identity>
   Image <proxies/image>
-   Keystore <proxies/keystore>
+   Key Management <proxies/key_management>
   Metric <proxies/metric>
   Network <proxies/network>
   Object Store <proxies/object_store>
@@ -107,7 +107,7 @@ The following services have exposed *Resource* classes.
   Database <resources/database/index>
   Identity <resources/identity/index>
   Image <resources/image/index>
-   Keystore <resources/keystore/index>
+   Key Management <resources/key_management/index>
   Metric <resources/metric/index>
   Network <resources/network/index>
   Orchestration <resources/orchestration/index>
--- a/doc/source/users/proxies/key_management.rst
+++ b/doc/source/users/proxies/key_management.rst
@@ -0,0 +1,18 @@
+KeyManagement API
+=================
+
+For details on how to use key_management, see
+:doc:`/users/userguides/key_management`
+
+.. automodule:: openstack.key_management.v1._proxy
+
+The KeyManagement Class
+-----------------------
+
+The key_management high-level interface is available through the
+``key_management`` member of a :class:`~openstack.connection.Connection`
+object.  The ``key_management`` member will only be added if the service is
+detected.
+
+.. autoclass:: openstack.key_management.v1._proxy.Proxy
+   :members:
--- a/doc/source/users/proxies/keystore.rst
+++ b/doc/source/users/proxies/keystore.rst
@@ -1,16 +0,0 @@
-Keystore API
-============
-
-For details on how to use keystore, see :doc:`/users/userguides/keystore`
-
-.. automodule:: openstack.keystore.v1._proxy
-
-The Keystore Class
------------------
-
-The keystore high-level interface is available through the ``keystore``
-member of a :class:`~openstack.connection.Connection` object.  The
-``keystore`` member will only be added if the service is detected.
-
-.. autoclass:: openstack.keystore.v1._proxy.Proxy
-   :members:
--- a/doc/source/users/resources/key_management/index.rst
+++ b/doc/source/users/resources/key_management/index.rst
@@ -1,5 +1,5 @@
-Keystore Resources
-==================
+KeyManagement Resources
+=======================

 .. toctree::
   :maxdepth: 1
--- a/doc/source/users/resources/key_management/v1/container.rst
+++ b/doc/source/users/resources/key_management/v1/container.rst
@@ -0,0 +1,12 @@
+openstack.key_management.v1.container
+=====================================
+
+.. automodule:: openstack.key_management.v1.container
+
+The Container Class
+-------------------
+
+The ``Container`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.key_management.v1.container.Container
+   :members:
--- a/doc/source/users/resources/key_management/v1/order.rst
+++ b/doc/source/users/resources/key_management/v1/order.rst
@@ -0,0 +1,12 @@
+openstack.key_management.v1.order
+=================================
+
+.. automodule:: openstack.key_management.v1.order
+
+The Order Class
+---------------
+
+The ``Order`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.key_management.v1.order.Order
+   :members:
--- a/doc/source/users/resources/key_management/v1/secret.rst
+++ b/doc/source/users/resources/key_management/v1/secret.rst
@@ -0,0 +1,12 @@
+openstack.key_management.v1.secret
+==================================
+
+.. automodule:: openstack.key_management.v1.secret
+
+The Secret Class
+----------------
+
+The ``Secret`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.key_management.v1.secret.Secret
+   :members:
--- a/doc/source/users/resources/keystore/v1/container.rst
+++ b/doc/source/users/resources/keystore/v1/container.rst
@@ -1,12 +0,0 @@
-openstack.keystore.v1.container
-===============================
-
-.. automodule:: openstack.keystore.v1.container
-
-The Container Class
-------------------
-
-The ``Container`` class inherits from :class:`~openstack.resource.Resource`.
-
-.. autoclass:: openstack.keystore.v1.container.Container
-   :members:
--- a/doc/source/users/resources/keystore/v1/order.rst
+++ b/doc/source/users/resources/keystore/v1/order.rst
@@ -1,12 +0,0 @@
-openstack.keystore.v1.order
-===========================
-
-.. automodule:: openstack.keystore.v1.order
-
-The Order Class
---------------
-
-The ``Order`` class inherits from :class:`~openstack.resource.Resource`.
-
-.. autoclass:: openstack.keystore.v1.order.Order
-   :members:
--- a/doc/source/users/resources/keystore/v1/secret.rst
+++ b/doc/source/users/resources/keystore/v1/secret.rst
@@ -1,12 +0,0 @@
-openstack.keystore.v1.secret
-============================
-
-.. automodule:: openstack.keystore.v1.secret
-
-The Secret Class
----------------
-
-The ``Secret`` class inherits from :class:`~openstack.resource.Resource`.
-
-.. autoclass:: openstack.keystore.v1.secret.Secret
-   :members:
--- a/doc/source/users/userguides/key_management.rst
+++ b/doc/source/users/userguides/key_management.rst
@@ -1,7 +1,7 @@
-Using OpenStack Keystore
-========================
+Using OpenStack KeyManagement
+=============================

-Before working with ``keystore``, you'll need to obtain a
+Before working with ``key_management``, you'll need to obtain a
 :class:`~openstack.connection.Connection` object like so.

 .. literalinclude:: /code/connection.py
--- a/openstack/key_management/init.py
+++ b/openstack/key_management/init.py
--- a/openstack/key_management/key_management_service.py
+++ b/openstack/key_management/key_management_service.py
@@ -13,12 +13,12 @@
 from openstack.auth import service_filter


-class KeystoreService(service_filter.ServiceFilter):
+class KeyManagementService(service_filter.ServiceFilter):
    """The image service."""

    valid_versions = [service_filter.ValidVersion('v1')]

    def __init__(self, version=None):
        """Create an image service."""
-        super(KeystoreService, self).__init__(service_type='keystore',
-                                              version=version)
+        super(KeyManagementService, self).__init__(service_type='key-manager',
+                                                   version=version)
--- a/openstack/key_management/v1/init.py
+++ b/openstack/key_management/v1/init.py
--- a/openstack/key_management/v1/_proxy.py
+++ b/openstack/key_management/v1/_proxy.py
@@ -10,9 +10,9 @@
 # License for the specific language governing permissions and limitations
 # under the License.

-from openstack.keystore.v1 import container
-from openstack.keystore.v1 import order
-from openstack.keystore.v1 import secret
+from openstack.key_management.v1 import container
+from openstack.key_management.v1 import order
+from openstack.key_management.v1 import secret
 from openstack import proxy


@@ -22,11 +22,11 @@ class Proxy(proxy.BaseProxy):
        """Create a new container from attributes

        :param dict attrs: Keyword arguments which will be used to create
-               a :class:`~openstack.keystore.v1.container.Container`,
+               a :class:`~openstack.key_management.v1.container.Container`,
               comprised of the properties on the Container class.

        :returns: The results of container creation
-        :rtype: :class:`~openstack.keystore.v1.container.Container`
+        :rtype: :class:`~openstack.key_management.v1.container.Container`
        """
        return self._create(container.Container, **attrs)

@@ -34,7 +34,8 @@ class Proxy(proxy.BaseProxy):
        """Delete a container

        :param value: The value can be either the ID of a container or a
-               :class:`~openstack.keystore.v2.container.Container` instance.
+               :class:`~openstack.key_management.v2.container.Container`
+               instance.
        :param bool ignore_missing: When set to ``False``
                    :class:`~openstack.exceptions.ResourceNotFound` will be
                    raised when the container does not exist.
@@ -58,10 +59,10 @@ class Proxy(proxy.BaseProxy):
        """Get a single container

        :param value: The value can be the ID of a container or a
-                      :class:`~openstack.keystore.v1.container.Container`
+                      :class:`~openstack.key_management.v1.container.Container`
                      instance.

-        :returns: One :class:`~openstack.keystore.v1.container.Container`
+        :returns: One :class:`~openstack.key_management.v1.container.Container`
        :raises: :class:`~openstack.exceptions.ResourceNotFound`
                 when no resource can be found.
        """
@@ -71,7 +72,7 @@ class Proxy(proxy.BaseProxy):
        """Return a generator of containers

        :returns: A generator of container objects
-        :rtype: :class:`~openstack.keystore.v1.container.Container`
+        :rtype: :class:`~openstack.key_management.v1.container.Container`
        """
        return self._list(container.Container, paginated=False)

@@ -93,11 +94,11 @@ class Proxy(proxy.BaseProxy):
        """Create a new order from attributes

        :param dict attrs: Keyword arguments which will be used to create
-                           a :class:`~openstack.keystore.v1.order.Order`,
+                           a :class:`~openstack.key_management.v1.order.Order`,
                           comprised of the properties on the Order class.

        :returns: The results of order creation
-        :rtype: :class:`~openstack.keystore.v1.order.Order`
+        :rtype: :class:`~openstack.key_management.v1.order.Order`
        """
        return self._create(order.Order, **attrs)

@@ -105,7 +106,8 @@ class Proxy(proxy.BaseProxy):
        """Delete an order

        :param value: The value can be either the ID of a order or a
-                      :class:`~openstack.keystore.v2.order.Order` instance.
+                      :class:`~openstack.key_management.v2.order.Order`
+                      instance.
        :param bool ignore_missing: When set to ``False``
                    :class:`~openstack.exceptions.ResourceNotFound` will be
                    raised when the order does not exist.
@@ -128,10 +130,10 @@ class Proxy(proxy.BaseProxy):
        """Get a single order

        :param value: The value can be the ID of an order or a
-                      :class:`~openstack.keystore.v1.order.Order`
+                      :class:`~openstack.key_management.v1.order.Order`
                      instance.

-        :returns: One :class:`~openstack.keystore.v1.order.Order`
+        :returns: One :class:`~openstack.key_management.v1.order.Order`
        :raises: :class:`~openstack.exceptions.ResourceNotFound`
                 when no resource can be found.
        """
@@ -141,7 +143,7 @@ class Proxy(proxy.BaseProxy):
        """Return a generator of orders

        :returns: A generator of order objects
-        :rtype: :class:`~openstack.keystore.v1.order.Order`
+        :rtype: :class:`~openstack.key_management.v1.order.Order`
        """
        return self._list(order.Order, paginated=False)

@@ -161,12 +163,12 @@ class Proxy(proxy.BaseProxy):
    def create_secret(self, **attrs):
        """Create a new secret from attributes

-        :param dict attrs: Keyword arguments which will be used to create
-                           a :class:`~openstack.keystore.v1.secret.Secret`,
+        :param dict attrs: Keyword arguments which will be used to create a
+                           :class:`~openstack.key_management.v1.secret.Secret`,
                           comprised of the properties on the Order class.

        :returns: The results of secret creation
-        :rtype: :class:`~openstack.keystore.v1.secret.Secret`
+        :rtype: :class:`~openstack.key_management.v1.secret.Secret`
        """
        return self._create(secret.Secret, **attrs)

@@ -174,7 +176,8 @@ class Proxy(proxy.BaseProxy):
        """Delete a secret

        :param value: The value can be either the ID of a secret or a
-                      :class:`~openstack.keystore.v2.secret.Secret` instance.
+                      :class:`~openstack.key_management.v2.secret.Secret`
+                      instance.
        :param bool ignore_missing: When set to ``False``
                    :class:`~openstack.exceptions.ResourceNotFound` will be
                    raised when the secret does not exist.
@@ -197,10 +200,10 @@ class Proxy(proxy.BaseProxy):
        """Get a single secret

        :param value: The value can be the ID of a secret or a
-                      :class:`~openstack.keystore.v1.secret.Secret`
+                      :class:`~openstack.key_management.v1.secret.Secret`
                      instance.

-        :returns: One :class:`~openstack.keystore.v1.secret.Secret`
+        :returns: One :class:`~openstack.key_management.v1.secret.Secret`
        :raises: :class:`~openstack.exceptions.ResourceNotFound`
                 when no resource can be found.
        """
@@ -210,7 +213,7 @@ class Proxy(proxy.BaseProxy):
        """Return a generator of secrets

        :returns: A generator of secret objects
-        :rtype: :class:`~openstack.keystore.v1.secret.Secret`
+        :rtype: :class:`~openstack.key_management.v1.secret.Secret`
        """
        return self._list(secret.Secret, paginated=False)

--- a/openstack/key_management/v1/container.py
+++ b/openstack/key_management/v1/container.py
@@ -10,7 +10,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.

-from openstack.keystore import keystore_service
+from openstack.key_management import key_management_service
 from openstack import resource


@@ -18,7 +18,7 @@ class Container(resource.Resource):
    id_attribute = 'container_ref'
    resources_key = 'containers'
    base_path = '/containers'
-    service = keystore_service.KeystoreService()
+    service = key_management_service.KeyManagementService()

    # capabilities
    allow_create = True
--- a/openstack/key_management/v1/order.py
+++ b/openstack/key_management/v1/order.py
@@ -10,14 +10,14 @@
 # License for the specific language governing permissions and limitations
 # under the License.

-from openstack.keystore import keystore_service
+from openstack.key_management import key_management_service
 from openstack import resource


 class Order(resource.Resource):
    resources_key = 'orders'
    base_path = '/orders'
-    service = keystore_service.KeystoreService()
+    service = key_management_service.KeyManagementService()

    # capabilities
    allow_create = True
--- a/openstack/key_management/v1/secret.py
+++ b/openstack/key_management/v1/secret.py
@@ -10,7 +10,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.

-from openstack.keystore import keystore_service
+from openstack.key_management import key_management_service
 from openstack import resource


@@ -19,7 +19,7 @@ class Secret(resource.Resource):
    resource_key = 'secret'
    resources_key = 'secrets'
    base_path = '/secrets'
-    service = keystore_service.KeystoreService()
+    service = key_management_service.KeyManagementService()

    # capabilities
    allow_create = True
--- a/openstack/profile.py
+++ b/openstack/profile.py
@@ -60,7 +60,7 @@ from openstack.database import database_service
 from openstack import exceptions
 from openstack.identity import identity_service
 from openstack.image import image_service
-from openstack.keystore import keystore_service
+from openstack.key_management import key_management_service
 from openstack.message import message_service
 from openstack.metric import metric_service
 from openstack.network import network_service
@@ -116,7 +116,7 @@ class Profile(object):
        serv = orchestration_service.OrchestrationService()
        serv.set_visibility(None)
        self._services[serv.service_type] = serv
-        serv = keystore_service.KeystoreService()
+        serv = key_management_service.KeyManagementService()
        serv.set_visibility(None)
        self._services[serv.service_type] = serv
        serv = telemetry_service.TelemetryService()
--- a/openstack/tests/unit/key_management/init.py
+++ b/openstack/tests/unit/key_management/init.py
--- a/openstack/tests/unit/key_management/test_key_management_service.py
+++ b/openstack/tests/unit/key_management/test_key_management_service.py
@@ -12,14 +12,14 @@

 import testtools

-from openstack.keystore import keystore_service
+from openstack.key_management import key_management_service


-class TestKeystoreService(testtools.TestCase):
+class TestKeyManagementService(testtools.TestCase):

    def test_service(self):
-        sot = keystore_service.KeystoreService()
-        self.assertEqual('keystore', sot.service_type)
+        sot = key_management_service.KeyManagementService()
+        self.assertEqual('key-manager', sot.service_type)
        self.assertEqual('public', sot.visibility)
        self.assertIsNone(sot.region)
        self.assertIsNone(sot.service_name)
--- a/openstack/tests/unit/key_management/v1/init.py
+++ b/openstack/tests/unit/key_management/v1/init.py
--- a/openstack/tests/unit/key_management/v1/test_container.py
+++ b/openstack/tests/unit/key_management/v1/test_container.py
@@ -12,7 +12,7 @@

 import testtools

-from openstack.keystore.v1 import container
+from openstack.key_management.v1 import container

 IDENTIFIER = 'http://localhost/containers/IDENTIFIER'
 EXAMPLE = {
@@ -33,7 +33,7 @@ class TestContainer(testtools.TestCase):
        self.assertEqual(None, sot.resource_key)
        self.assertEqual('containers', sot.resources_key)
        self.assertEqual('/containers', sot.base_path)
-        self.assertEqual('keystore', sot.service.service_type)
+        self.assertEqual('key-manager', sot.service.service_type)
        self.assertTrue(sot.allow_create)
        self.assertTrue(sot.allow_retrieve)
        self.assertTrue(sot.allow_update)
--- a/openstack/tests/unit/key_management/v1/test_order.py
+++ b/openstack/tests/unit/key_management/v1/test_order.py
@@ -12,7 +12,7 @@

 import testtools

-from openstack.keystore.v1 import order
+from openstack.key_management.v1 import order

 IDENTIFIER = 'IDENTIFIER'
 EXAMPLE = {
@@ -33,7 +33,7 @@ class TestOrder(testtools.TestCase):
        self.assertEqual(None, sot.resource_key)
        self.assertEqual('orders', sot.resources_key)
        self.assertEqual('/orders', sot.base_path)
-        self.assertEqual('keystore', sot.service.service_type)
+        self.assertEqual('key-manager', sot.service.service_type)
        self.assertTrue(sot.allow_create)
        self.assertTrue(sot.allow_retrieve)
        self.assertTrue(sot.allow_update)
--- a/openstack/tests/unit/key_management/v1/test_proxy.py
+++ b/openstack/tests/unit/key_management/v1/test_proxy.py
@@ -10,16 +10,16 @@
 # License for the specific language governing permissions and limitations
 # under the License.

-from openstack.keystore.v1 import _proxy
-from openstack.keystore.v1 import container
-from openstack.keystore.v1 import order
-from openstack.keystore.v1 import secret
+from openstack.key_management.v1 import _proxy
+from openstack.key_management.v1 import container
+from openstack.key_management.v1 import order
+from openstack.key_management.v1 import secret
 from openstack.tests.unit import test_proxy_base


-class TestKeystoreProxy(test_proxy_base.TestProxyBase):
+class TestKeyManagementProxy(test_proxy_base.TestProxyBase):
    def setUp(self):
-        super(TestKeystoreProxy, self).setUp()
+        super(TestKeyManagementProxy, self).setUp()
        self.proxy = _proxy.Proxy(self.session)

    def test_server_create_attrs(self):
@@ -34,8 +34,9 @@ class TestKeystoreProxy(test_proxy_base.TestProxyBase):
                           container.Container, True)

    def test_container_find(self):
-        self.verify_find('openstack.keystore.v1.container.Container.find',
-                         self.proxy.find_container)
+        self.verify_find(
+            'openstack.key_management.v1.container.Container.find',
+            self.proxy.find_container)

    def test_container_get(self):
        self.verify_get(self.proxy.get_container, container.Container)
@@ -57,7 +58,7 @@ class TestKeystoreProxy(test_proxy_base.TestProxyBase):
        self.verify_delete(self.proxy.delete_order, order.Order, True)

    def test_order_find(self):
-        self.verify_find('openstack.keystore.v1.order.Order.find',
+        self.verify_find('openstack.key_management.v1.order.Order.find',
                         self.proxy.find_order)

    def test_order_get(self):
@@ -79,7 +80,7 @@ class TestKeystoreProxy(test_proxy_base.TestProxyBase):
        self.verify_delete(self.proxy.delete_secret, secret.Secret, True)

    def test_secret_find(self):
-        self.verify_find('openstack.keystore.v1.secret.Secret.find',
+        self.verify_find('openstack.key_management.v1.secret.Secret.find',
                         self.proxy.find_secret)

    def test_secret_get(self):
--- a/openstack/tests/unit/key_management/v1/test_secret.py
+++ b/openstack/tests/unit/key_management/v1/test_secret.py
@@ -12,7 +12,7 @@

 import testtools

-from openstack.keystore.v1 import secret
+from openstack.key_management.v1 import secret

 IDENTIFIER = 'http://localhost:9311/v1/secrets/ID'
 EXAMPLE = {
@@ -35,7 +35,7 @@ class TestSecret(testtools.TestCase):
        self.assertEqual('secret', sot.resource_key)
        self.assertEqual('secrets', sot.resources_key)
        self.assertEqual('/secrets', sot.base_path)
-        self.assertEqual('keystore', sot.service.service_type)
+        self.assertEqual('key-manager', sot.service.service_type)
        self.assertTrue(sot.allow_create)
        self.assertTrue(sot.allow_retrieve)
        self.assertTrue(sot.allow_update)
--- a/openstack/tests/unit/test_profile.py
+++ b/openstack/tests/unit/test_profile.py
@@ -24,7 +24,7 @@ class TestProfile(base.TestCase):
            'database',
            'identity',
            'image',
-            'keystore',
+            'key-manager',
            'messaging',
            'metering',
            'metric',