Merge pull request noironetworks#278 from noironetworks/nested

Add the NestedParameter and VlanRange table

Author: Bob Kukura

aim/aim_manager.py

@@ -84,6 +84,7 @@ class AimManager(object):
                      api_infra.HostDomainMappingV2,
                      api_infra.HostLinkNetworkLabel,
                      api_infra.ApicAssignment,
+                     api_infra.NestedParameter,
                      api_res.SecurityGroup,
                      api_res.SecurityGroupSubject,
                      api_res.SecurityGroupRule,

aim/aim_store.py

@@ -233,6 +233,7 @@ class SqlAlchemyStore(AimStore):
                     api_infra.HostLinkNetworkLabel: (
                         infra_model.HostLinkNetworkLabel),
                     api_infra.ApicAssignment: infra_model.ApicAssignment,
+                    api_infra.NestedParameter: infra_model.NestedParameter,
                     api_res.SecurityGroup: models.SecurityGroup,
                     api_res.SecurityGroupSubject: models.SecurityGroupSubject,
                     api_res.SecurityGroupRule: models.SecurityGroupRule,

aim/api/infra.py

@@ -20,6 +20,7 @@
 
 from aim.api import resource
 from aim.api import types as t
+from aim import exceptions as exc
 
 WILDCARD_HOST = '*'
 LOG = logging.getLogger(__name__)
@@ -154,3 +155,46 @@ def is_available(self, context):
             LOG.debug("APIC %s is not available. Last update time was %s" %
                       (self.apic_host, self.last_update_timestamp))
             return False
+
+
+# REVISIT(kentwu): We will need to deprecate this once there is
+# a proper fix in the openShift IPI installer.
+class NestedParameter(resource.ResourceBase):
+    """Nested parameters needed for openShift on openStack install"""
+
+    identity_attributes = t.identity(
+        ('project_id', t.name),
+        ('cluster_name', t.name))
+    other_attributes = t.other(
+        ('domain_name', t.name),
+        ('domain_type', t.string(32)),
+        ('domain_infra_vlan', t.string()),
+        ('domain_service_vlan', t.string()),
+        ('domain_node_vlan', t.string()),
+        ('vlan_range_list', t.list_of_vlan_range))
+
+    def __init__(self, **kwargs):
+        for vlan_type in ['domain_infra_vlan', 'domain_service_vlan',
+                          'domain_node_vlan']:
+            vlan = kwargs.get(vlan_type)
+            if vlan and (int(vlan) < 0 or int(vlan) > 4095):
+                raise exc.AciResourceValueError(klass=type(self).__name__,
+                                                value=vlan,
+                                                attr=vlan_type)
+        vlan_range_list = kwargs.get('vlan_range_list', [])
+        for vlan_range in vlan_range_list:
+            if 'start' not in vlan_range or 'end' not in vlan_range:
+                continue
+            start = int(vlan_range['start'])
+            end = int(vlan_range['end'])
+            if (start > end or start < 0 or start > 4095 or
+                    end < 0 or end > 4095):
+                raise exc.AciResourceValueError(klass=type(self).__name__,
+                                                value=vlan_range,
+                                                attr='vlan_range_list')
+        super(NestedParameter, self).__init__({'domain_type': 'k8s',
+                                               'domain_infra_vlan': '0',
+                                               'domain_service_vlan': '0',
+                                               'domain_node_vlan': '0',
+                                               'vlan_range_list': []},
+                                              **kwargs)

aim/api/types.py

@@ -157,3 +157,8 @@ def list_of_dicts(*dict_keys_and_types):
                    "preference": {"type": "string"}}}
 list_of_next_hop = {"type": "array", "items": next_hop}
 epoch = integer
+vlan_range = {
+    "type": "object",
+    "properties": {"start": string(),
+                   "end": string()}}
+list_of_vlan_range = {"type": "array", "items": vlan_range}

aim/db/infra_model.py

@@ -15,6 +15,7 @@
 
 import sqlalchemy as sa
 from sqlalchemy.dialects.mysql import VARCHAR
+from sqlalchemy import orm
 from sqlalchemy.sql.expression import func
 
 from aim.api import infra
@@ -164,3 +165,63 @@ class ApicAssignment(model_base.Base, model_base.AttributeMixin):
     aim_aid_id = sa.Column(sa.String(64))
     last_update_timestamp = sa.Column(sa.TIMESTAMP, server_default=func.now(),
                                       onupdate=func.now())
+
+
+# REVISIT(kentwu): We will need to deprecate this class along with
+# NestedParameter class once there is a proper fix in the openShift
+# IPI installer.
+class VlanRange(model_base.Base):
+    """DB model for vlan ranges under a NestedParameter."""
+
+    __tablename__ = 'aim_vlan_ranges'
+
+    nested_parameter_aim_id = sa.Column(
+        sa.Integer, sa.ForeignKey('aim_nested_parameter.aim_id'),
+        primary_key=True)
+    start = sa.Column(sa.Integer, primary_key=True)
+    end = sa.Column(sa.Integer, nullable=False)
+
+
+class NestedParameter(model_base.Base, model_base.HasAimId,
+                      model_base.AttributeMixin):
+    __tablename__ = 'aim_nested_parameter'
+
+    project_id = model_base.name_column(nullable=False)
+    cluster_name = model_base.name_column(nullable=False)
+    __table_args__ = (model_base.uniq_column(__tablename__, 'project_id',
+                                             'cluster_name') +
+                      model_base.to_tuple(model_base.Base.__table_args__))
+
+    domain_name = model_base.name_column()
+    domain_type = sa.Column(sa.String(32), nullable=False)
+    domain_infra_vlan = sa.Column(sa.Integer, nullable=False)
+    domain_service_vlan = sa.Column(sa.Integer, nullable=False)
+    domain_node_vlan = sa.Column(sa.Integer, nullable=False)
+
+    vlan_range_list = orm.relationship(VlanRange,
+                                       backref='nested_parameter',
+                                       cascade='all, delete-orphan',
+                                       lazy='joined')
+
+    def from_attr(self, session, res_attr):
+        if 'vlan_range_list' in res_attr:
+            vlan_range_list = []
+            for p in (res_attr.pop('vlan_range_list', []) or []):
+                if p.get('start') and p.get('end'):
+                    vlan_range_list.append(VlanRange(
+                        start=int(p['start']), end=int(p['end'])))
+            self.vlan_range_list = vlan_range_list
+
+        # map remaining attributes to model
+        super(NestedParameter, self).from_attr(session, res_attr)
+
+    def to_attr(self, session):
+        res_attr = super(NestedParameter, self).to_attr(session)
+        for vlan_type in ['domain_infra_vlan', 'domain_service_vlan',
+                          'domain_node_vlan']:
+            if vlan_type in res_attr:
+                res_attr[vlan_type] = str(res_attr[vlan_type])
+        for p in res_attr.pop('vlan_range_list', []):
+            res_attr.setdefault('vlan_range_list', []).append(
+                {'start': str(p.start), 'end': str(p.end)})
+        return res_attr

aim/db/migration/alembic_migrations/versions/8c6cbd136805_nested_parameter.py

@@ -0,0 +1,65 @@
+# Copyright (c) 2016 Cisco Systems
+# 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.
+
+"""Create table for NestedParameter and VlanRange.
+
+Revision ID: 8c6cbd136805
+Revises: 3880e0a62e1f
+Create Date: 2020-02-21 19:02:47.560600
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '8c6cbd136805'
+down_revision = '3880e0a62e1f'
+branch_labels = None
+depends_on = None
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    op.create_table(
+        'aim_nested_parameter',
+        sa.Column('aim_id', sa.String(255), nullable=False),
+        sa.Column('project_id', sa.String(64), nullable=False),
+        sa.Column('cluster_name', sa.String(64), nullable=False),
+        sa.Column('domain_name', sa.String(64)),
+        sa.Column('domain_type', sa.String(32), nullable=False),
+        sa.Column('domain_infra_vlan', sa.Integer, nullable=False),
+        sa.Column('domain_service_vlan', sa.Integer, nullable=False),
+        sa.Column('domain_node_vlan', sa.Integer, nullable=False),
+        sa.Column('epoch', sa.BigInteger(), nullable=False,
+                  server_default='0'),
+        sa.PrimaryKeyConstraint('aim_id'),
+        sa.UniqueConstraint('project_id', 'cluster_name',
+                            name='uniq_aim_nested_parameter_identity'),
+        sa.Index('idx_aim_nested_parameter_identity',
+                 'project_id', 'cluster_name'))
+
+    op.create_table(
+        'aim_vlan_ranges',
+        sa.Column('nested_parameter_aim_id', sa.String(255),
+                  nullable=False),
+        sa.Column('start', sa.Integer, nullable=False),
+        sa.Column('end', sa.Integer),
+        sa.PrimaryKeyConstraint('nested_parameter_aim_id', 'start'),
+        sa.ForeignKeyConstraint(['nested_parameter_aim_id'],
+                                ['aim_nested_parameter.aim_id']))
+
+
+def downgrade():
+    pass

aim/db/migration/alembic_migrations/versions/HEAD

@@ -1 +1 @@
-3880e0a62e1f
+8c6cbd136805