Files
openstacksdk/doc/source/users/proxies/clustering.rst
Monty Taylor 4bad718783 Rework config and rest layers
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
2017-11-15 11:46:50 -06:00

6.6 KiB

Cluster API

openstack.clustering.v1._proxy

The Cluster Class

The cluster high-level interface is available through the cluster member of a ~openstack.connection.Connection object. The cluster member will only be added if the service is detected.

Build Info Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.get_build_info

Profile Type Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.profile_types

openstack.clustering.v1._proxy.Proxy.get_profile_type

Profile Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.create_profile

openstack.clustering.v1._proxy.Proxy.update_profile

openstack.clustering.v1._proxy.Proxy.delete_profile

openstack.clustering.v1._proxy.Proxy.get_profile

openstack.clustering.v1._proxy.Proxy.find_profile

openstack.clustering.v1._proxy.Proxy.profiles

openstack.clustering.v1._proxy.Proxy.validate_profile

Policy Type Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.policy_types

openstack.clustering.v1._proxy.Proxy.get_policy_type

Policy Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.create_policy

openstack.clustering.v1._proxy.Proxy.update_policy

openstack.clustering.v1._proxy.Proxy.delete_policy

openstack.clustering.v1._proxy.Proxy.get_policy

openstack.clustering.v1._proxy.Proxy.find_policy

openstack.clustering.v1._proxy.Proxy.policies

openstack.clustering.v1._proxy.Proxy.validate_policy

Cluster Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.create_cluster

openstack.clustering.v1._proxy.Proxy.update_cluster

openstack.clustering.v1._proxy.Proxy.delete_cluster

openstack.clustering.v1._proxy.Proxy.get_cluster

openstack.clustering.v1._proxy.Proxy.find_cluster

openstack.clustering.v1._proxy.Proxy.clusters

openstack.clustering.v1._proxy.Proxy.check_cluster

openstack.clustering.v1._proxy.Proxy.recover_cluster

openstack.clustering.v1._proxy.Proxy.resize_cluster

openstack.clustering.v1._proxy.Proxy.scale_in_cluster

openstack.clustering.v1._proxy.Proxy.scale_out_cluster

openstack.clustering.v1._proxy.Proxy.collect_cluster_attrs

openstack.clustering.v1._proxy.Proxy.perform_operation_on_cluster

openstack.clustering.v1._proxy.Proxy.add_nodes_to_cluster

openstack.clustering.v1._proxy.Proxy.remove_nodes_from_cluster

openstack.clustering.v1._proxy.Proxy.replace_nodes_in_cluster

openstack.clustering.v1._proxy.Proxy.attach_policy_to_cluster

openstack.clustering.v1._proxy.Proxy.update_cluster_policy

openstack.clustering.v1._proxy.Proxy.detach_policy_from_cluster

openstack.clustering.v1._proxy.Proxy.get_cluster_policy

openstack.clustering.v1._proxy.Proxy.cluster_policies

openstack.clustering.v1._proxy.Proxy.cluster_add_nodes

openstack.clustering.v1._proxy.Proxy.cluster_attach_policy

openstack.clustering.v1._proxy.Proxy.cluster_del_nodes

openstack.clustering.v1._proxy.Proxy.cluster_detach_policy

openstack.clustering.v1._proxy.Proxy.cluster_operation

openstack.clustering.v1._proxy.Proxy.cluster_replace_nodes

openstack.clustering.v1._proxy.Proxy.cluster_resize

openstack.clustering.v1._proxy.Proxy.cluster_scale_in

openstack.clustering.v1._proxy.Proxy.cluster_scale_out

openstack.clustering.v1._proxy.Proxy.cluster_update_policy

Node Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.create_node

openstack.clustering.v1._proxy.Proxy.update_node

openstack.clustering.v1._proxy.Proxy.delete_node

openstack.clustering.v1._proxy.Proxy.get_node

openstack.clustering.v1._proxy.Proxy.find_node

openstack.clustering.v1._proxy.Proxy.nodes

openstack.clustering.v1._proxy.Proxy.check_node

openstack.clustering.v1._proxy.Proxy.recover_node

openstack.clustering.v1._proxy.Proxy.perform_operation_on_node

openstack.clustering.v1._proxy.Proxy.adopt_node

openstack.clustering.v1._proxy.Proxy.node_operation

Receiver Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.create_receiver

openstack.clustering.v1._proxy.Proxy.update_receiver

openstack.clustering.v1._proxy.Proxy.delete_receiver

openstack.clustering.v1._proxy.Proxy.get_receiver

openstack.clustering.v1._proxy.Proxy.find_receiver

openstack.clustering.v1._proxy.Proxy.receivers

Action Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.get_action

openstack.clustering.v1._proxy.Proxy.actions

Event Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.get_event

openstack.clustering.v1._proxy.Proxy.events

Helper Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.wait_for_delete

openstack.clustering.v1._proxy.Proxy.wait_for_status

Service Operations

openstack.clustering.v1._proxy.Proxy

openstack.clustering.v1._proxy.Proxy.services