4bad718783
This is a large and invasive change to the underlying guts. Most casual use should not notice a difference, but advanced users, especially those using the Profile or Authenticator interfaces or making use of pluggable providers will be broken. The overall intent is to align directly on top of the mechanisms that came from os-client-config for config and to use keystoneauth1's Adapter interface to make use of the canonical implementations of such things as service and version discovery. The end goal is that openstacksdk provides the REST interaction layer for python-openstackclient, shade, Ansible and nodepool. Replace profile with openstack.config os-client-config is used by shade and python-openstackclient to read and process configuration. openstacksdk also can use the os-client-config interface, but translates it internally into the Profile object. As os-client-config has been injested into openstack.config, remove Profile and just use the config classes. Make proxy subclass of adapter This gives every service a generic passthrough for REST calls, which means we can map unknown service-type values to a generic proxy. Strip endpoint_filter We're passing Adapters around, not sessions. Doing so means that self.service and endpoint_filter have become unnecessary. Rename _Request.uri to _Request.url This is a stepping-stone to replacing _Request with requests.Request and using requests.Session.prepare_request inside of _prepare_request. Rename service proxy instances to match their official service-type. Aliases are kept for the old versions, but make the canonical versions match the official name. Rename bare_metal to baremetal Rename cluster to clustering Rename block_store to block_storage Rename telemetry to meter Create generic proxies for all services in STA Every service listed in service types authority is an OpenStack service. Even if we don't know about it in SDK, we should at the very least have a low-level Adapter for it so that people can use REST calls while waiting on the SDK to add higher-level constructs. The pypy jobs are happily green. Run them as voting rather than non-voting. Add syntatic sugar alias for making connections Typing: import openstack.connection conn = openstack.connection.Connection(cloud='example') is annoying. This allows: import openstack conn = openstack.connect(cloud='example') Use task_manager and Adapter from shade As a stepping-stone towards shade and sdk codepaths being rationalized, we need to get SDK using the Adapter from shade that submits requests into the TaskManager. For normal operation this is a passthrough/no-op sort of thing, but it's essential for high-volume consumers such as nodepool. This exposes a bunch of places in tests where we're mocking a bit too deeply. We should go back through and fix all of those via requests_mock, but that's WAY too much for today. This was a 'for later' task, but it turns out that the move to Adapter was causing exceptions to be thrown that were not the exceptions that were intended to be caught in the SDK layer, which was causing functional tests of things like GET operations to fail. So it became a today task. Change-Id: I7b46e263a76d84573bdfbbece57b1048764ed939
103 lines
2.7 KiB
ReStructuredText
103 lines
2.7 KiB
ReStructuredText
..
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
=================
|
|
Managing Policies
|
|
=================
|
|
|
|
A **policy type** can be treated as the meta-type of a `Policy` object. A
|
|
registry of policy types is built when the Cluster service starts. When
|
|
creating a `Policy` object, you will indicate the policy type used in its
|
|
`spec` property.
|
|
|
|
|
|
List Policies
|
|
~~~~~~~~~~~~~
|
|
|
|
To examine the list of policies:
|
|
|
|
.. literalinclude:: ../../examples/clustering/policy.py
|
|
:pyobject: list_policies
|
|
|
|
When listing policies, you can specify the sorting option using the ``sort``
|
|
parameter and you can do pagination using the ``limit`` and ``marker``
|
|
parameters.
|
|
|
|
Full example: `manage policy`_
|
|
|
|
|
|
Create Policy
|
|
~~~~~~~~~~~~~
|
|
|
|
When creating a policy, you will provide a dictionary with keys and values
|
|
according to the policy type referenced.
|
|
|
|
.. literalinclude:: ../../examples/clustering/policy.py
|
|
:pyobject: create_policy
|
|
|
|
Optionally, you can specify a ``metadata`` keyword argument that contains some
|
|
key-value pairs to be associated with the policy.
|
|
|
|
Full example: `manage policy`_
|
|
|
|
|
|
Find Policy
|
|
~~~~~~~~~~~
|
|
|
|
To find a policy based on its name or ID:
|
|
|
|
.. literalinclude:: ../../examples/clustering/policy.py
|
|
:pyobject: find_policy
|
|
|
|
Full example: `manage policy`_
|
|
|
|
|
|
Get Policy
|
|
~~~~~~~~~~
|
|
|
|
To get a policy based on its name or ID:
|
|
|
|
.. literalinclude:: ../../examples/clustering/policy.py
|
|
:pyobject: get_policy
|
|
|
|
Full example: `manage policy`_
|
|
|
|
|
|
Update Policy
|
|
~~~~~~~~~~~~~
|
|
|
|
After a policy is created, most of its properties are immutable. Still, you
|
|
can update a policy's ``name`` and/or ``metadata``.
|
|
|
|
.. literalinclude:: ../../examples/clustering/policy.py
|
|
:pyobject: update_policy
|
|
|
|
The Cluster service doesn't allow updating the ``spec`` of a policy. The only
|
|
way to achieve that is to create a new policy.
|
|
|
|
Full example: `manage policy`_
|
|
|
|
|
|
Delete Policy
|
|
~~~~~~~~~~~~~
|
|
|
|
A policy can be deleted after creation, provided that it is not referenced
|
|
by any active clusters or nodes. If you attempt to delete a policy that is
|
|
still in use, you will get an error message.
|
|
|
|
.. literalinclude:: ../../examples/clustering/policy.py
|
|
:pyobject: delete_policy
|
|
|
|
|
|
.. _manage policy: http://git.openstack.org/cgit/openstack/python-openstacksdk/tree/examples/clustering/policy.py
|