
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
2.5 KiB
Meter API
Caution
BETA: This API is a work in progress and is subject to change.
For details on how to use meter, see /users/guides/meter
openstack.meter.v2._proxy
The Meter Class
The meter high-level interface is available through the
meter
member of a ~openstack.connection.Connection
object. The
meter
member will only be added if the service is
detected.
Sample Operations
openstack.meter.v2._proxy.Proxy
openstack.meter.v2._proxy.Proxy.find_sample
openstack.meter.v2._proxy.Proxy.samples
Statistic Operations
openstack.meter.v2._proxy.Proxy
openstack.meter.v2._proxy.Proxy.find_statistics
openstack.meter.v2._proxy.Proxy.statistics
Resource Operations
openstack.meter.v2._proxy.Proxy
openstack.meter.v2._proxy.Proxy.get_resource
openstack.meter.v2._proxy.Proxy.find_resource
openstack.meter.v2._proxy.Proxy.resources
Meter Operations
openstack.meter.v2._proxy.Proxy
openstack.meter.v2._proxy.Proxy.find_meter
openstack.meter.v2._proxy.Proxy.meters
Capability Operations
openstack.meter.v2._proxy.Proxy
openstack.meter.v2._proxy.Proxy.find_capability
openstack.meter.v2._proxy.Proxy.capabilities
The Alarm Class
The alarm high-level interface is available through the
meter.alarm
member of a ~openstack.connection.Connection
object. The
meter.alarm
member will only be added if the service is
detected.
Alarm Operations
openstack.meter.alarm.v2._proxy.Proxy
openstack.meter.alarm.v2._proxy.Proxy.create_alarm
openstack.meter.alarm.v2._proxy.Proxy.update_alarm
openstack.meter.alarm.v2._proxy.Proxy.delete_alarm
openstack.meter.alarm.v2._proxy.Proxy.get_alarm
openstack.meter.alarm.v2._proxy.Proxy.find_alarm
openstack.meter.alarm.v2._proxy.Proxy.alarms
Alarm Change Operations
openstack.meter.alarm.v2._proxy.Proxy
openstack.meter.alarm.v2._proxy.Proxy.find_alarm_change
openstack.meter.alarm.v2._proxy.Proxy.alarm_changes