File: sfc.py

package info (click to toggle)
python-neutron-lib 3.21.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,660 kB
  • sloc: python: 22,829; sh: 137; makefile: 24
file content (281 lines) | stat: -rw-r--r-- 9,536 bytes parent folder | download | duplicates (5)
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# All rights reserved.
#
#    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 neutron_lib.api import converters
from neutron_lib.api.definitions import flowclassifier as fc_api
from neutron_lib import constants
from neutron_lib.db import constants as db_const

# The alias of the extension.
ALIAS = 'sfc'

# Whether or not this extension is simply signaling behavior to the user
# or it actively modifies the attribute map.
IS_SHIM_EXTENSION = False

# Whether the extension is marking the adoption of standardattr model for
# legacy resources, or introducing new standardattr attributes. False or
# None if the standardattr model is adopted since the introduction of
# resource extension.
# If this is True, the alias for the extension should be prefixed with
# 'standard-attr-'.
IS_STANDARD_ATTR_EXTENSION = False

# The name of the extension.
NAME = 'Service Function Chaining'

# The description of the extension.
DESCRIPTION = "Provides support for Service Function Chaining"

# A timestamp of when the extension was last updated.
UPDATED_TIMESTAMP = "2015-10-05T10:00:00-00:00"

API_PREFIX = '/sfc'

# Service Function Chaining constants
PORT_PAIRS = 'port_pairs'
PORT_PAIR_GROUPS = 'port_pair_groups'
PORT_CHAINS = 'port_chains'
MAX_CHAIN_ID = 65535

MPLS = 'mpls'
NSH = 'nsh'

PPG_N_TUPLE_DICT_SPEC = {
    'source_ip_prefix': {
        'default': None,
        'type:subnet_or_none': None
    },
    'destination_ip_prefix': {
        'default': None,
        'type:subnet_or_none': None
    },
    'source_port_range_min': {
        'default': None,
        'convert_to': converters.convert_to_int_if_not_none,
        'type:range_or_none': [0, constants.PORT_MAX]
    },
    'source_port_range_max': {
        'default': None,
        'convert_to': converters.convert_to_int_if_not_none,
        'type:range_or_none': [0, constants.PORT_MAX]
    },
    'destination_port_range_min': {
        'default': None,
        'convert_to': converters.convert_to_int_if_not_none,
        'type:range_or_none': [0, constants.PORT_MAX]
    },
    'destination_port_range_max': {
        'default': None,
        'convert_to': converters.convert_to_int_if_not_none,
        'type:range_or_none': [0, constants.PORT_MAX]
    }
}

# The resource attribute map for the extension.
RESOURCE_ATTRIBUTE_MAP = {
    PORT_PAIRS: {
        'id': {
            'allow_post': False, 'allow_put': False,
            'is_visible': True,
            'validate': {'type:uuid': None},
            'primary_key': True
        },
        'name': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True, 'default': '',
            'validate': {'type:string': db_const.NAME_FIELD_SIZE},
        },
        'description': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True, 'default': '',
            'validate': {'type:string': db_const.DESCRIPTION_FIELD_SIZE},
        },
        'tenant_id': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True,
            'validate': {'type:string': db_const.PROJECT_ID_FIELD_SIZE},
            'required_by_policy': True
        },
        'ingress': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True,
            'validate': {'type:uuid': None}
        },
        'egress': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True,
            'validate': {'type:uuid': None}
        },
        'service_function_parameters': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True,
            'dict_populate_defaults': True,
            'validate': {
                'type:dict': {
                    'correlation': {
                        'type:values': [None, MPLS, NSH],
                        'default': None
                    },
                    'weight': {
                        'type:non_negative': None,
                        'default': 1,
                        'convert_to': converters.convert_to_int
                    }
                }
            }
        }
    },
    PORT_PAIR_GROUPS: {
        'id': {
            'allow_post': False, 'allow_put': False,
            'is_visible': True,
            'validate': {'type:uuid': None},
            'primary_key': True},
        'group_id': {
            'allow_post': False, 'allow_put': False,
            'is_visible': True
        },
        'name': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True, 'default': '',
            'validate': {'type:string': db_const.NAME_FIELD_SIZE},
        },
        'description': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True, 'default': '',
            'validate': {'type:string': db_const.DESCRIPTION_FIELD_SIZE},
        },
        'tenant_id': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True,
            'validate': {'type:string': db_const.PROJECT_ID_FIELD_SIZE},
            'required_by_policy': True
        },
        'port_pairs': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True, 'default': None,
            'validate': {'type:uuid_list': None},
            'convert_to': converters.convert_none_to_empty_list
        },
        'port_pair_group_parameters': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True,
            'dict_populate_defaults': True,
            'validate': {
                'type:dict': {
                    'lb_fields': {
                        'type:list_of_regex_or_none':
                            'eth|ip|tcp|udp)_(src|dst)',
                        'default': []
                    },
                    'ppg_n_tuple_mapping': {
                        'dict_populate_defaults': True,
                        'type:dict': {
                            'ingress_n_tuple': {
                                'type:dict': PPG_N_TUPLE_DICT_SPEC,
                                'default': {}
                            },
                            'egress_n_tuple': {
                                'type:dict': PPG_N_TUPLE_DICT_SPEC,
                                'default': {}
                            }
                        }
                    }
                }
            }
        }
    },
    PORT_CHAINS: {
        'id': {
            'allow_post': False, 'allow_put': False,
            'is_visible': True,
            'validate': {'type:uuid': None},
            'primary_key': True
        },
        'chain_id': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True, 'default': 0,
            'validate': {'type:range': (0, MAX_CHAIN_ID)},
            'convert_to': converters.convert_to_int
        },
        'name': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True, 'default': '',
            'validate': {'type:string': db_const.NAME_FIELD_SIZE},
        },
        'description': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True, 'default': '',
            'validate': {'type:string': db_const.DESCRIPTION_FIELD_SIZE},
        },
        'tenant_id': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True,
            'validate': {'type:string': db_const.PROJECT_ID_FIELD_SIZE},
            'required_by_policy': True
        },
        'port_pair_groups': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True,
            'validate': {'type:uuid_list_non_empty': None},
            'default': None
        },
        'flow_classifiers': {
            'allow_post': True, 'allow_put': True,
            'is_visible': True, 'default': None,
            'validate': {'type:uuid_list': None},
            'convert_to': converters.convert_to_list
        },
        'chain_parameters': {
            'allow_post': True, 'allow_put': False,
            'is_visible': True,
            'dict_populate_defaults': True,
            'validate': {
                'type:dict': {
                    'correlation': {
                        'type:values': [MPLS, NSH],
                        'default': MPLS
                    },
                    'symmetric': {
                        'type:boolean': None,
                        'default': False,
                        'convert_to': converters.convert_to_boolean
                    }
                }
            },
        }
    }
}

# The subresource attribute map for the extension. It adds child resources
# to main extension's resource. The subresource map must have a parent and
# a parameters entry. If an extension does not need such a map, None can
# be specified (mandatory).
SUB_RESOURCE_ATTRIBUTE_MAP = None

# The action map.
ACTION_MAP = {
}

ACTION_STATUS = {
}
# The list of required extensions.
REQUIRED_EXTENSIONS = [
    fc_api.ALIAS,
]

# The list of optional extensions.
OPTIONAL_EXTENSIONS = [
]