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
212
213
214
215
216
217
218
219
220
221
222
223
224
|
#
# 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.
from heat.common import exception
from heat.common.i18n import _
from heat.engine import attributes
from heat.engine import constraints
from heat.engine import properties
from heat.engine.resources.openstack.neutron import net
from heat.engine import support
class ProviderNet(net.Net):
"""A resource for managing Neutron provider networks.
Provider networks specify details of physical realisation of the existing
network.
The default policy usage of this resource is limited to
administrators only.
"""
required_service_extension = 'provider'
support_status = support.SupportStatus(version='2014.1')
PROPERTIES = (
NAME, PROVIDER_NETWORK_TYPE, PROVIDER_PHYSICAL_NETWORK,
PROVIDER_SEGMENTATION_ID, ADMIN_STATE_UP, SHARED,
PORT_SECURITY_ENABLED, ROUTER_EXTERNAL, DNS_DOMAIN, TAGS,
) = (
'name', 'network_type', 'physical_network',
'segmentation_id', 'admin_state_up', 'shared',
'port_security_enabled', 'router_external', 'dns_domain', 'tags',
)
ATTRIBUTES = (
STATUS, SUBNETS,
) = (
'status', 'subnets',
)
NETWORK_TYPES = (
LOCAL, VLAN, VXLAN, GRE, GENEVE, FLAT
) = (
'local', 'vlan', 'vxlan', 'gre', 'geneve', 'flat'
)
properties_schema = {
NAME: net.Net.properties_schema[NAME],
PROVIDER_NETWORK_TYPE: properties.Schema(
properties.Schema.STRING,
_('A string specifying the provider network type for the '
'network.'),
update_allowed=True,
required=True,
constraints=[
constraints.AllowedValues(NETWORK_TYPES),
]
),
PROVIDER_PHYSICAL_NETWORK: properties.Schema(
properties.Schema.STRING,
_('A string specifying physical network mapping for the '
'network.'),
update_allowed=True
),
PROVIDER_SEGMENTATION_ID: properties.Schema(
properties.Schema.STRING,
_('A string specifying the segmentation id for the '
'network.'),
update_allowed=True
),
ADMIN_STATE_UP: net.Net.properties_schema[ADMIN_STATE_UP],
SHARED: properties.Schema(
properties.Schema.BOOLEAN,
_('Whether this network should be shared across all tenants.'),
default=True,
update_allowed=True
),
PORT_SECURITY_ENABLED: properties.Schema(
properties.Schema.BOOLEAN,
_('Flag to enable/disable port security on the network. It '
'provides the default value for the attribute of the ports '
'created on this network.'),
update_allowed=True,
support_status=support.SupportStatus(version='8.0.0')
),
ROUTER_EXTERNAL: properties.Schema(
properties.Schema.BOOLEAN,
_('Whether the network contains an external router.'),
default=False,
update_allowed=True,
support_status=support.SupportStatus(version='6.0.0')
),
TAGS: properties.Schema(
properties.Schema.LIST,
_('The tags to be added to the provider network.'),
schema=properties.Schema(properties.Schema.STRING),
update_allowed=True,
support_status=support.SupportStatus(version='12.0.0')
),
DNS_DOMAIN: properties.Schema(
properties.Schema.STRING,
_('DNS domain associated with this network.'),
constraints=[
constraints.CustomConstraint('dns_domain')
],
update_allowed=True,
support_status=support.SupportStatus(version='15.0.0')
),
}
attributes_schema = {
STATUS: attributes.Schema(
_("The status of the network."),
type=attributes.Schema.STRING
),
SUBNETS: attributes.Schema(
_("Subnets of this network."),
type=attributes.Schema.LIST
),
}
def validate(self):
"""Resource's validation.
Validates to ensure that segmentation_id is not there for flat
network type.
"""
super(ProviderNet, self).validate()
if (self.properties[self.PROVIDER_SEGMENTATION_ID] and
self.properties[self.PROVIDER_NETWORK_TYPE] != 'vlan'):
msg = _('segmentation_id not allowed for flat network type.')
raise exception.StackValidationFailed(message=msg)
@staticmethod
def add_provider_extension(props, key):
props['provider:' + key] = props.pop(key)
@staticmethod
def prepare_provider_properties(props):
if ProviderNet.PROVIDER_NETWORK_TYPE in props:
ProviderNet.add_provider_extension(
props,
ProviderNet.PROVIDER_NETWORK_TYPE)
if ProviderNet.PROVIDER_PHYSICAL_NETWORK in props:
ProviderNet.add_provider_extension(
props,
ProviderNet.PROVIDER_PHYSICAL_NETWORK)
if ProviderNet.PROVIDER_SEGMENTATION_ID in props:
ProviderNet.add_provider_extension(
props,
ProviderNet.PROVIDER_SEGMENTATION_ID)
if ProviderNet.ROUTER_EXTERNAL in props:
props['router:external'] = props.pop(ProviderNet.ROUTER_EXTERNAL)
def handle_create(self):
"""Creates the resource with provided properties.
Adds 'provider:' extension to the required properties during create.
"""
props = self.prepare_properties(
self.properties,
self.physical_resource_name())
ProviderNet.prepare_provider_properties(props)
tags = props.pop(self.TAGS, [])
prov_net = self.client().create_network({'network': props})['network']
self.resource_id_set(prov_net['id'])
if tags:
self.set_tags(tags)
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
"""Updates the resource with provided properties.
Adds 'provider:' extension to the required properties during update.
"""
if prop_diff:
ProviderNet.prepare_provider_properties(prop_diff)
self.prepare_update_properties(prop_diff)
if self.TAGS in prop_diff:
self.set_tags(prop_diff.pop(self.TAGS))
if prop_diff:
self.client().update_network(self.resource_id,
{'network': prop_diff})
def parse_live_resource_data(self, resource_properties, resource_data):
# this resource should not have super in case of we don't need to
# parse Net resource properties.
result = {}
provider_keys = [self.PROVIDER_NETWORK_TYPE,
self.PROVIDER_PHYSICAL_NETWORK,
self.PROVIDER_SEGMENTATION_ID]
for key in provider_keys:
result[key] = resource_data.get('provider:%s' % key)
result[self.ROUTER_EXTERNAL] = resource_data.get('router:external')
provider_keys.append(self.ROUTER_EXTERNAL)
provider_keys.append(self.SHARED)
for key in set(self.PROPERTIES) - set(provider_keys):
if key in resource_data:
result[key] = resource_data.get(key)
return result
def resource_mapping():
return {
'OS::Neutron::ProviderNet': ProviderNet,
}
|
