7fc1888d19
This is just a big name swap to move away from UserPreference to Profile so it can be properly referenced in the summit talk. See #1435953 Change-Id: Iaa45fce0c8aacc9315070f8525a13f2e43f05a9e Closes-Bug: 1435953
204 lines
7.2 KiB
Python
204 lines
7.2 KiB
Python
# 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.
|
|
|
|
"""
|
|
:class:`~openstack.profile.Profile` is the class that is used to
|
|
define the various preferences for different services. The preferences that
|
|
are currently supported are service name, region, version and visibility.
|
|
The :class:`~openstack.profile.Profile` and the
|
|
:class:`~openstack.connection.Connection` classes are the most important
|
|
user facing classes.
|
|
|
|
Examples
|
|
--------
|
|
|
|
The :class:`~openstack.profile.Profile` class is constructed
|
|
with no arguments.
|
|
|
|
Set Methods
|
|
~~~~~~~~~~~
|
|
|
|
A user's preferences are set based on the service type. Service type would
|
|
normally be something like 'compute', 'identity', 'object-store', etc.::
|
|
|
|
from openstack import profile
|
|
prof = profile.Profile()
|
|
prof.set_name('compute', 'matrix')
|
|
prof.set_region(prof.ALL, 'zion')
|
|
prof.set_version('identity', 'v3')
|
|
prof.set_visibility('object-store', 'internal')
|
|
for service in prof.get_services():
|
|
print str(prof.get_preference(service.service_type))
|
|
|
|
The resulting preference print out would look something like::
|
|
|
|
service_type=compute,region=zion,service_name=matrix
|
|
service_type=network,region=zion
|
|
service_type=database,region=zion
|
|
service_type=image,region=zion
|
|
service_type=metering,region=zion
|
|
service_type=orchestration,region=zion
|
|
service_type=object-store,visibility=internal,region=zion
|
|
service_type=identity,region=zion,version=v3
|
|
"""
|
|
|
|
import six
|
|
|
|
from openstack.compute import compute_service
|
|
from openstack.database import database_service
|
|
from openstack import exceptions
|
|
from openstack.identity import identity_service
|
|
from openstack.image import image_service
|
|
from openstack.keystore import keystore_service
|
|
from openstack.metric import metric_service
|
|
from openstack.network import network_service
|
|
from openstack.object_store import object_store_service
|
|
from openstack.orchestration import orchestration_service
|
|
from openstack.telemetry import telemetry_service
|
|
from openstack.volume import volume_service
|
|
|
|
|
|
class Profile(object):
|
|
|
|
ALL = "*"
|
|
"""Wildcard service identifier representing all services."""
|
|
|
|
def __init__(self):
|
|
"""Preferences for each service.
|
|
|
|
Create a new :class:`~openstack.profile.Profile`
|
|
object with no preferences defined, but knowledge of the services.
|
|
Services are identified by their service type, e.g.: 'identity',
|
|
'compute', etc.
|
|
"""
|
|
self._preferences = {}
|
|
self._services = {}
|
|
"""
|
|
NOTE(thowe): We should probably do something more clever here rather
|
|
than brute force create all the services. Maybe use entry points
|
|
or something, but I'd like to leave that work for another commit.
|
|
"""
|
|
serv = compute_service.ComputeService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = database_service.DatabaseService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = identity_service.IdentityService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = image_service.ImageService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = metric_service.MetricService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = network_service.NetworkService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = object_store_service.ObjectStoreService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = orchestration_service.OrchestrationService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = keystore_service.KeystoreService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = telemetry_service.TelemetryService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
serv = volume_service.VolumeService()
|
|
serv.set_visibility(None)
|
|
self._services[serv.service_type] = serv
|
|
|
|
self.service_names = sorted(self._services.keys())
|
|
|
|
def __repr__(self):
|
|
return repr(self._preferences)
|
|
|
|
def get_preference(self, service):
|
|
"""Get a service preference.
|
|
|
|
:param str service: Desired service type.
|
|
"""
|
|
return self._preferences.get(service, None)
|
|
|
|
def get_services(self):
|
|
"""Get a list of all the known services."""
|
|
services = []
|
|
for name, service in six.iteritems(self._services):
|
|
services.append(service)
|
|
return services
|
|
|
|
def _get_service(self, service):
|
|
"""Get a valid service filter."""
|
|
serv = self._services.get(service, None)
|
|
if serv is not None:
|
|
self._preferences[service] = serv
|
|
return serv
|
|
msg = ("Service %s not in list of valid services: %s" %
|
|
(service, self.service_names))
|
|
raise exceptions.SDKException(msg)
|
|
|
|
def set_name(self, service, name):
|
|
"""Set the desired name for the specified service.
|
|
|
|
:param str service: Service type.
|
|
:param str name: Desired service name.
|
|
"""
|
|
if service == self.ALL:
|
|
services = self.service_names
|
|
else:
|
|
services = [service]
|
|
for service in services:
|
|
self._get_service(service).service_name = name
|
|
|
|
def set_region(self, service, region):
|
|
"""Set the desired region for the specified service.
|
|
|
|
:param str service: Service type.
|
|
:param str region: Desired service region.
|
|
"""
|
|
if service == self.ALL:
|
|
services = self.service_names
|
|
else:
|
|
services = [service]
|
|
for service in services:
|
|
self._get_service(service).region = region
|
|
|
|
def set_version(self, service, version):
|
|
"""Set the desired version for the specified service.
|
|
|
|
:param str service: Service type.
|
|
:param str version: Desired service version.
|
|
"""
|
|
if service == self.ALL:
|
|
services = self.service_names
|
|
else:
|
|
services = [service]
|
|
for service in services:
|
|
self._get_service(service).version = version
|
|
|
|
def set_visibility(self, service, visibility):
|
|
"""Set the desired visibility for the specified service.
|
|
|
|
:param str service: Service type.
|
|
:param str visibility: Desired service visibility.
|
|
"""
|
|
if service == self.ALL:
|
|
services = self.service_names
|
|
else:
|
|
services = [service]
|
|
for service in services:
|
|
self._get_service(service).set_visibility(visibility)
|