openstack/deb-python-openstacksdk
Code Issues Proposed changes

Rename key_management to key_manager

Browse Source 
Some time ago, the Key Management service was renamed to Key Manager
service in the governance repo. We originally stuck to naming it Key
Management *because* it was named as such in the projects.yaml file, and
because it has changed, we should follow how it's named there.

Change-Id: Id5c1bd617a02e21e91f01ec095f817222c535138
This commit is contained in:
Brian Curtin
2015-12-15 12:15:51 -06:00
parent f3f06b2067
commit 1c739d307e
25 changed files with 106 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/users/guides/key_management.rst → doc/source/users/guides/key_manager.rst
View File

@@ -1,7 +1,7 @@
Using OpenStack Key Management
==============================
Using OpenStack Key Manager
===========================
Before working with the Key Management service, you'll need to create a
Before working with the Key Manager service, you'll need to create a
connection to your OpenStack cloud by following the :doc:`connect` user
guide. This will provide you with the ``conn`` variable used in the examples
below.

6
doc/source/users/index.rst
View File

@@ -33,7 +33,7 @@ approach, this is where you'll want to begin.
Database <guides/database>
Identity <guides/identity>
Image <guides/image>
Key Management <guides/key_management>
Key Manager <guides/key_manager>
Network <guides/network>
Object Store <guides/object_store>
Orchestration <guides/orchestration>
@@ -73,7 +73,7 @@ but listed below are the ones provided by this SDK by default.
Database <proxies/database>
Identity <proxies/identity>
Image <proxies/image>
Key Management <proxies/key_management>
Key Manager <proxies/key_manager>
Network <proxies/network>
Object Store <proxies/object_store>
Orchestration <proxies/orchestration>
@@ -99,7 +99,7 @@ The following services have exposed *Resource* classes.
Database <resources/database/index>
Identity <resources/identity/index>
Image <resources/image/index>
Key Management <resources/key_management/index>
Key Management <resources/key_manager/index>
Metric <resources/metric/index>
Network <resources/network/index>
Orchestration <resources/orchestration/index>

18
doc/source/users/proxies/key_management.rst
View File

@@ -1,18 +0,0 @@
KeyManagement API
=================
For details on how to use key_management, see
:doc:`/users/guides/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:

18
doc/source/users/proxies/key_manager.rst Normal file
View File

@@ -0,0 +1,18 @@
KeyManager API
==============
For details on how to use key_management, see
:doc:`/users/guides/key_manager`
.. automodule:: openstack.key_manager.v1._proxy
The KeyManager Class
--------------------
The key_management high-level interface is available through the
``key_manager`` member of a :class:`~openstack.connection.Connection`
object. The ``key_manager`` member will only be added if the service is
detected.
.. autoclass:: openstack.key_manager.v1._proxy.Proxy
:members:

12
doc/source/users/resources/key_management/v1/order.rst
View File

@@ -1,12 +0,0 @@
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:

12
doc/source/users/resources/key_management/v1/secret.rst
View File

@@ -1,12 +0,0 @@
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:

4
doc/source/users/resources/key_management/index.rst → doc/source/users/resources/key_manager/index.rst
View File

@@ -1,5 +1,5 @@
KeyManagement Resources
=======================
KeyManager Resources
====================
.. toctree::
:maxdepth: 1

6
doc/source/users/resources/key_management/v1/container.rst → doc/source/users/resources/key_manager/v1/container.rst
View File

@@ -1,12 +1,12 @@
openstack.key_management.v1.container
openstack.key_manager.v1.container
=====================================
.. automodule:: openstack.key_management.v1.container
.. automodule:: openstack.key_manager.v1.container
The Container Class
-------------------
The ``Container`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.key_management.v1.container.Container
.. autoclass:: openstack.key_manager.v1.container.Container
:members:

12
doc/source/users/resources/key_manager/v1/order.rst Normal file
View File

@@ -0,0 +1,12 @@
openstack.key_manager.v1.order
==============================
.. automodule:: openstack.key_manager.v1.order
The Order Class
---------------
The ``Order`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.key_manager.v1.order.Order
:members:

12
doc/source/users/resources/key_manager/v1/secret.rst Normal file
View File

@@ -0,0 +1,12 @@
openstack.key_manager.v1.secret
===============================
.. automodule:: openstack.key_manager.v1.secret
The Secret Class
----------------
The ``Secret`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.key_manager.v1.secret.Secret
:members:

0
openstack/key_management/__init__.py → openstack/key_manager/__init__.py
View File

10
openstack/key_management/key_management_service.py → openstack/key_manager/key_manager_service.py
View File

@@ -13,12 +13,12 @@
from openstack import service_filter
class KeyManagementService(service_filter.ServiceFilter):
"""The key management service."""
class KeyManagerService(service_filter.ServiceFilter):
"""The key manager service."""
valid_versions = [service_filter.ValidVersion('v1')]
def __init__(self, version=None):
"""Create a key management service."""
super(KeyManagementService, self).__init__(service_type='key-manager',
version=version)
"""Create a key manager service."""
super(KeyManagerService, self).__init__(service_type='key-manager',
version=version)

0
openstack/key_management/v1/__init__.py → openstack/key_manager/v1/__init__.py
View File

60
openstack/key_management/v1/_proxy.py → openstack/key_manager/v1/_proxy.py
View File

@@ -10,9 +10,9 @@
# License for the specific language governing permissions and limitations
# under the License.
from openstack.key_management.v1 import container as _container
from openstack.key_management.v1 import order as _order
from openstack.key_management.v1 import secret as _secret
from openstack.key_manager.v1 import container as _container
from openstack.key_manager.v1 import order as _order
from openstack.key_manager.v1 import secret as _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.key_management.v1.container.Container`,
a :class:`~openstack.key_manager.v1.container.Container`,
comprised of the properties on the Container class.
:returns: The results of container creation
:rtype: :class:`~openstack.key_management.v1.container.Container`
:rtype: :class:`~openstack.key_manager.v1.container.Container`
"""
return self._create(_container.Container, **attrs)
@@ -34,7 +34,7 @@ class Proxy(proxy.BaseProxy):
"""Delete a container
:param container: The value can be either the ID of a container or a
:class:`~openstack.key_management.v1.container.Container`
:class:`~openstack.key_manager.v1.container.Container`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be
@@ -56,7 +56,7 @@ class Proxy(proxy.BaseProxy):
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.key_management.v1.container.Container`
:returns: One :class:`~openstack.key_manager.v1.container.Container`
or None
"""
return self._find(_container.Container, name_or_id,
@@ -66,10 +66,10 @@ class Proxy(proxy.BaseProxy):
"""Get a single container
:param container: The value can be the ID of a container or a
:class:`~openstack.key_management.v1.container.Container`
:class:`~openstack.key_manager.v1.container.Container`
instance.
:returns: One :class:`~openstack.key_management.v1.container.Container`
:returns: One :class:`~openstack.key_manager.v1.container.Container`
:raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found.
"""
@@ -82,7 +82,7 @@ class Proxy(proxy.BaseProxy):
the resources being returned.
:returns: A generator of container objects
:rtype: :class:`~openstack.key_management.v1.container.Container`
:rtype: :class:`~openstack.key_manager.v1.container.Container`
"""
return self._list(_container.Container, paginated=False, **query)
@@ -90,13 +90,13 @@ class Proxy(proxy.BaseProxy):
"""Update a container
:param container: Either the id of a container or a
:class:`~openstack.key_management.v1.container.Container`
:class:`~openstack.key_manager.v1.container.Container`
instance.
:attrs kwargs: The attributes to update on the container represented
by ``value``.
:returns: The updated container
:rtype: :class:`~openstack.key_management.v1.container.Container`
:rtype: :class:`~openstack.key_manager.v1.container.Container`
"""
return self._update(_container.Container, container, **attrs)
@@ -104,11 +104,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.key_management.v1.order.Order`,
a :class:`~openstack.key_manager.v1.order.Order`,
comprised of the properties on the Order class.
:returns: The results of order creation
:rtype: :class:`~openstack.key_management.v1.order.Order`
:rtype: :class:`~openstack.key_manager.v1.order.Order`
"""
return self._create(_order.Order, **attrs)
@@ -116,7 +116,7 @@ class Proxy(proxy.BaseProxy):
"""Delete an order
:param order: The value can be either the ID of a order or a
:class:`~openstack.key_management.v1.order.Order`
:class:`~openstack.key_manager.v1.order.Order`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be
@@ -137,7 +137,7 @@ class Proxy(proxy.BaseProxy):
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.key_management.v1.order.Order` or None
:returns: One :class:`~openstack.key_manager.v1.order.Order` or None
"""
return self._find(_order.Order, name_or_id,
ignore_missing=ignore_missing)
@@ -146,10 +146,10 @@ class Proxy(proxy.BaseProxy):
"""Get a single order
:param order: The value can be the ID of an order or a
:class:`~openstack.key_management.v1.order.Order`
:class:`~openstack.key_manager.v1.order.Order`
instance.
:returns: One :class:`~openstack.key_management.v1.order.Order`
:returns: One :class:`~openstack.key_manager.v1.order.Order`
:raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found.
"""
@@ -162,7 +162,7 @@ class Proxy(proxy.BaseProxy):
the resources being returned.
:returns: A generator of order objects
:rtype: :class:`~openstack.key_management.v1.order.Order`
:rtype: :class:`~openstack.key_manager.v1.order.Order`
"""
return self._list(_order.Order, paginated=False, **query)
@@ -170,13 +170,13 @@ class Proxy(proxy.BaseProxy):
"""Update a order
:param order: Either the id of a order or a
:class:`~openstack.key_management.v1.order.Order`
:class:`~openstack.key_manager.v1.order.Order`
instance.
:attrs kwargs: The attributes to update on the order represented
by ``value``.
:returns: The updated order
:rtype: :class:`~openstack.key_management.v1.order.Order`
:rtype: :class:`~openstack.key_manager.v1.order.Order`
"""
return self._update(_order.Order, order, **attrs)
@@ -184,11 +184,11 @@ class Proxy(proxy.BaseProxy):
"""Create a new secret from attributes
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.key_management.v1.secret.Secret`,
:class:`~openstack.key_manager.v1.secret.Secret`,
comprised of the properties on the Order class.
:returns: The results of secret creation
:rtype: :class:`~openstack.key_management.v1.secret.Secret`
:rtype: :class:`~openstack.key_manager.v1.secret.Secret`
"""
return self._create(_secret.Secret, **attrs)
@@ -196,7 +196,7 @@ class Proxy(proxy.BaseProxy):
"""Delete a secret
:param secret: The value can be either the ID of a secret or a
:class:`~openstack.key_management.v1.secret.Secret`
:class:`~openstack.key_manager.v1.secret.Secret`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be
@@ -217,7 +217,7 @@ class Proxy(proxy.BaseProxy):
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.key_management.v1.secret.Secret` or
:returns: One :class:`~openstack.key_manager.v1.secret.Secret` or
None
"""
return self._find(_secret.Secret, name_or_id,
@@ -227,10 +227,10 @@ class Proxy(proxy.BaseProxy):
"""Get a single secret
:param secret: The value can be the ID of a secret or a
:class:`~openstack.key_management.v1.secret.Secret`
:class:`~openstack.key_manager.v1.secret.Secret`
instance.
:returns: One :class:`~openstack.key_management.v1.secret.Secret`
:returns: One :class:`~openstack.key_manager.v1.secret.Secret`
:raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found.
"""
@@ -243,7 +243,7 @@ class Proxy(proxy.BaseProxy):
the resources being returned.
:returns: A generator of secret objects
:rtype: :class:`~openstack.key_management.v1.secret.Secret`
:rtype: :class:`~openstack.key_manager.v1.secret.Secret`
"""
return self._list(_secret.Secret, paginated=False, **query)
@@ -251,12 +251,12 @@ class Proxy(proxy.BaseProxy):
"""Update a secret
:param secret: Either the id of a secret or a
:class:`~openstack.key_management.v1.secret.Secret`
:class:`~openstack.key_manager.v1.secret.Secret`
instance.
:attrs kwargs: The attributes to update on the secret represented
by ``value``.
:returns: The updated secret
:rtype: :class:`~openstack.key_management.v1.secret.Secret`
:rtype: :class:`~openstack.key_manager.v1.secret.Secret`
"""
return self._update(_secret.Secret, secret, **attrs)

4
openstack/key_management/v1/container.py → openstack/key_manager/v1/container.py
View File

@@ -10,7 +10,7 @@
# License for the specific language governing permissions and limitations
# under the License.
from openstack.key_management import key_management_service
from openstack.key_manager import key_manager_service
from openstack import resource
@@ -18,7 +18,7 @@ class Container(resource.Resource):
id_attribute = 'container_ref'
resources_key = 'containers'
base_path = '/containers'
service = key_management_service.KeyManagementService()
service = key_manager_service.KeyManagerService()
# capabilities
allow_create = True

4
openstack/key_management/v1/order.py → openstack/key_manager/v1/order.py
View File

@@ -10,14 +10,14 @@
# License for the specific language governing permissions and limitations
# under the License.
from openstack.key_management import key_management_service
from openstack.key_manager import key_manager_service
from openstack import resource
class Order(resource.Resource):
resources_key = 'orders'
base_path = '/orders'
service = key_management_service.KeyManagementService()
service = key_manager_service.KeyManagerService()
# capabilities
allow_create = True

4
openstack/key_management/v1/secret.py → openstack/key_manager/v1/secret.py
View File

@@ -10,7 +10,7 @@
# License for the specific language governing permissions and limitations
# under the License.
from openstack.key_management import key_management_service
from openstack.key_manager import key_manager_service
from openstack import resource
@@ -19,7 +19,7 @@ class Secret(resource.Resource):
resource_key = 'secret'
resources_key = 'secrets'
base_path = '/secrets'
service = key_management_service.KeyManagementService()
service = key_manager_service.KeyManagerService()
# capabilities
allow_create = True

4
openstack/profile.py
View File

@@ -62,7 +62,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.key_management import key_management_service
from openstack.key_manager import key_manager_service
from openstack.message import message_service
from openstack import module_loader
from openstack.network import network_service
@@ -97,7 +97,7 @@ class Profile(object):
self._add_service(network_service.NetworkService())
self._add_service(object_store_service.ObjectStoreService())
self._add_service(orchestration_service.OrchestrationService())
self._add_service(key_management_service.KeyManagementService())
self._add_service(key_manager_service.KeyManagerService())
self._add_service(telemetry_service.TelemetryService())
self._add_service(block_store_service.BlockStoreService())
self._add_service(message_service.MessageService())

0
openstack/tests/unit/key_management/__init__.py → openstack/tests/unit/key_manager/__init__.py
View File

6
openstack/tests/unit/key_management/test_key_management_service.py → openstack/tests/unit/key_manager/test_key_management_service.py
View File

@@ -12,13 +12,13 @@
import testtools
from openstack.key_management import key_management_service
from openstack.key_manager import key_manager_service
class TestKeyManagementService(testtools.TestCase):
class TestKeyManagerService(testtools.TestCase):
def test_service(self):
sot = key_management_service.KeyManagementService()
sot = key_manager_service.KeyManagerService()
self.assertEqual('key-manager', sot.service_type)
self.assertEqual('public', sot.interface)
self.assertIsNone(sot.region)

0
openstack/tests/unit/key_management/v1/__init__.py → openstack/tests/unit/key_manager/v1/__init__.py
View File

2
openstack/tests/unit/key_management/v1/test_container.py → openstack/tests/unit/key_manager/v1/test_container.py
View File

@@ -12,7 +12,7 @@
import testtools
from openstack.key_management.v1 import container
from openstack.key_manager.v1 import container
IDENTIFIER = 'http://localhost/containers/IDENTIFIER'
EXAMPLE = {

2
openstack/tests/unit/key_management/v1/test_order.py → openstack/tests/unit/key_manager/v1/test_order.py
View File

@@ -12,7 +12,7 @@
import testtools
from openstack.key_management.v1 import order
from openstack.key_manager.v1 import order
IDENTIFIER = 'IDENTIFIER'
EXAMPLE = {

8
openstack/tests/unit/key_management/v1/test_proxy.py → openstack/tests/unit/key_manager/v1/test_proxy.py
View File

@@ -10,10 +10,10 @@
# License for the specific language governing permissions and limitations
# under the License.
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.key_manager.v1 import _proxy
from openstack.key_manager.v1 import container
from openstack.key_manager.v1 import order
from openstack.key_manager.v1 import secret
from openstack.tests.unit import test_proxy_base

2
openstack/tests/unit/key_management/v1/test_secret.py → openstack/tests/unit/key_manager/v1/test_secret.py
View File

@@ -12,7 +12,7 @@
import testtools
from openstack.key_management.v1 import secret
from openstack.key_manager.v1 import secret
IDENTIFIER = 'http://localhost:9311/v1/secrets/ID'
EXAMPLE = {