Bases: object
This is the task flow engine
Use this engine to start/load flows in the code
Bases: BlockingConductor
Bases: Job
Bases: DynamicLoggingConductor
Bases: object
Create cinder client object.
region – The region of the service
service_name – The name of the cinder service in the catalog
endpoint – The endpoint of the service
endpoint_type – The endpoint type of the service
insecure – Turn off certificate validation
cacert – CA Cert file path
a Cinder Client object
Exception – if the client cannot be created
Bases: object
Create glance client object.
region – The region of the service
service_name – The name of the glance service in the catalog
endpoint – The endpoint of the service
endpoint_type – The endpoint_type of the service
insecure – Turn off certificate validation
cacert – CA Cert file path
a Glance Client object.
Exception – if the client cannot be created
Bases: object
Create neutron client object.
region – The region of the service
service_name – The name of the neutron service in the catalog
endpoint – The endpoint of the service
endpoint_type – The endpoint_type of the service
insecure – Turn off certificate validation
ca_cert – CA Cert file path
a Neutron Client object.
Exception – if the client cannot be created
Get neutron client for request user.
It’s possible that the token in the context is a trust scoped which can’t be used to initialize a keystone session.
We directly use the token and endpoint_url to initialize neutron client.
Bases: object
Create nova client object.
region – The region of the service
service_name – The name of the nova service in the catalog
endpoint – The endpoint of the service
endpoint_type – The type of the endpoint
insecure – Turn off certificate validation
cacert – CA Cert file path
a Nova Client object.
Exception – if the client cannot be created
Routines for configuring Octavia
Update default value for configuration options from other namespace.
Example, oslo lib config options. This is needed for config generator tool to pick these default value changes. https://docs.openstack.org/oslo.config/latest/cli/ generator.html#modifying-defaults-from-other-namespaces
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: object
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Bases: BaseDataModel
Decorators to provide backwards compatibility for V1 API.
Octavia base exception handling.
Bases: HTTPClientError
Bases: OctaviaException
Bases: OctaviaException
Bases: APIException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: OctaviaException
Bases: APIException
Bases: OctaviaException
Bases: OctaviaException
Bases: APIException
Bases: OctaviaException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: OctaviaException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: OctaviaException
Bases: APIException
Bases: APIException
Bases: OctaviaException
Bases: APIException
Bases: OctaviaException
Bases: OctaviaException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: OctaviaException
Bases: APIException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: OctaviaException
Bases: APIException
Bases: APIException
Bases: Exception
Base Octavia Exception.
To correctly use this class, inherit from it and define a ‘message’ property. That message will get printf’d with the keyword arguments provided to the constructor.
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: OctaviaException
Bases: OctaviaException
Bases: APIException
Bases: APIException
Bases: OctaviaException
Bases: APIException
Bases: APIException
Bases: APIException
Bases: OctaviaException
Bases: OctaviaException
Bases: AuthProtocol
SkippingAuthProtocol to reach special endpoints
Bypasses keystone authentication for special request paths, such as the api version discovery path.
SkippingAuthProtocol is lean customization
of keystonemiddleware.auth_token.AuthProtocol
that disables keystone communication if the request path
is in the _NOAUTH_PATHS list.
Process request.
Evaluate the headers in a request and attempt to authenticate the request. If authenticated then additional headers are added to the request for use by applications. If not authenticated the request will be rejected or marked unauthenticated depending on configuration.
Policy Engine For Octavia.
Bases: Enforcer
Verifies that the action is valid on the target in this context.
context – The oslo context for this request.
action – string representing the action to be checked
this should be colon separated for clarity.
i.e. compute:create_instance
,
compute:attach_volume
,
volume:attach_volume
target – dictionary representing the object of the action
for object creation this should be a dictionary representing the
location of the object e.g.
{'project_id': context.project_id}
do_raise – if True (the default), raises PolicyForbidden; if False, returns False
exc – Class of the exceptions to raise if the check fails.
Any remaining arguments passed to enforce()
(both
positional and keyword arguments) will be passed to
the exceptions class. If not specified,
PolicyForbidden
will be used.
PolicyForbidden – if verification fails and do_raise is True. Or if ‘exc’ is specified it will raise an exceptions of that type.
returns a non-False value (not necessarily “True”) if authorized, and the exact value False if not authorized and do_raise is False.
Utilities and helper functions.
Get a b64-encoded sha1 hash of a string. Not intended to be secure!
Bases: object
Wrap a function and log raised exception
logger – the logger to log the exception default is LOG.exception
origin value if no exception raised; re-raise the exception if any occurred
Expand the expected code string in set of codes.
200-204 -> 200, 201, 202, 204 200, 203 -> 200, 203
Several handy validation functions that go beyond simple type checking. Defined here so these can also be used at deeper levels than the API.
Checks a TLS version string against the configured minimum.
Raises an error if the value string contains invalid characters.
Raises an error if header does not look like an HTML header name.
Raises an error if the value string contains invalid characters.
Raises an exception when a network does not exist.
If a subnet is provided, also validate the network contains that subnet.
Validate and make consistent L7Policy API arguments.
This method is mainly meant to sanitize L7 Policy create and update API dictionaries, so that we strip ‘None’ values that don’t apply for our particular update. This method does not verify that any redirect_pool_id exists in the database, but will raise an error if a redirect_url doesn’t look like a URL.
l7policy – The L7 Policy dictionary we are santizing / validating
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.