forked from openstack/openstacksdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprofile.py
More file actions
211 lines (182 loc) · 7.53 KB
/
profile.py
File metadata and controls
211 lines (182 loc) · 7.53 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# 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.block_store import block_store_service
from openstack.cluster import cluster_service
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.message import message_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
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 = cluster_service.ClusterService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
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 = block_store_service.BlockStoreService()
serv.set_visibility(None)
self._services[serv.service_type] = serv
serv = message_service.MessageService()
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)