openstacksdk/doc/source/user/guides/key_manager.rst
Monty Taylor 40d425c595
Merge user and users sections of the docs
The openstack doc standard location is 'user', so go with that.
Incorporate pages from the shade and occ docs into the appropriate
places in the user index file.

This still leaves user/logging and user/guide/logging which need to be
rationalized. That will come in the next commit, as it also needs to
actually rationalize the logging helper functions.

Remove the Makefile, as it's not used by things.

Change-Id: I26f36370ef9651f4bcaa7dee3b903309463d9592
2018-01-15 19:19:50 -06:00

2.0 KiB

Using OpenStack Key Manager

Before working with the Key Manager service, you'll need to create a connection to your OpenStack cloud by following the connect user guide. This will provide you with the conn variable used in the examples below.

Table of Contents

Note

Some interactions with the Key Manager service differ from that of other services in that resources do not have a proper id parameter, which is necessary to make some calls. Instead, resources have a separately named id attribute, e.g., the Secret resource has secret_id.

The examples below outline when to pass in those id values.

Create a Secret

The Key Manager service allows you to create new secrets by passing the attributes of the ~openstack.key_manager.v1.secret.Secret to the ~openstack.key_manager.v1._proxy.Proxy.create_secret method.

../examples/key_manager/create.py

List Secrets

Once you have stored some secrets, they are available for you to list via the ~openstack.key_manager.v1._proxy.Proxy.secrets method. This method returns a generator, which yields each ~openstack.key_manager.v1.secret.Secret.

../examples/key_manager/list.py

The ~openstack.key_manager.v1._proxy.Proxy.secrets method can also make more advanced queries to limit the secrets that are returned.

../examples/key_manager/list.py

Get Secret Payload

Once you have received a ~openstack.key_manager.v1.secret.Secret, you can obtain the payload for it by passing the secret's id value to the ~openstack.key_manager.v1._proxy.Proxy.secrets method. Use the ~openstack.key_manager.v1.secret.Secret.secret_id attribute when making this request.

../examples/key_manager/get.py