[CORD-2053] initial commit for create vspgwc service
Change-Id: Ic6d2be493f4eeae095e450a6ebeb54ad80510ddf
diff --git a/xos/make_synchronizer_manifest.sh b/xos/make_synchronizer_manifest.sh
new file mode 100755
index 0000000..5351287
--- /dev/null
+++ b/xos/make_synchronizer_manifest.sh
@@ -0,0 +1,16 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+#! /bin/bash
+find synchronizer -type f | cut -b 14- > synchronizer/manifest
diff --git a/xos/synchronizer/Dockerfile.synchronizer b/xos/synchronizer/Dockerfile.synchronizer
new file mode 100644
index 0000000..0d92be6
--- /dev/null
+++ b/xos/synchronizer/Dockerfile.synchronizer
@@ -0,0 +1,39 @@
+# xosproject/vspgwc-synchronizer
+FROM xosproject/xos-synchronizer-base:candidate
+
+COPY . /opt/xos/synchronizers/vspgwc
+
+ENTRYPOINT []
+
+WORKDIR "/opt/xos/synchronizers/vspgwc"
+
+# Label image
+ARG org_label_schema_schema_version=1.0
+ARG org_label_schema_name=vspgwc-synchronizer
+ARG org_label_schema_version=unknown
+ARG org_label_schema_vcs_url=unknown
+ARG org_label_schema_vcs_ref=unknown
+ARG org_label_schema_build_date=unknown
+ARG org_opencord_vcs_commit_date=unknown
+ARG org_opencord_component_chameleon_version=unknown
+ARG org_opencord_component_chameleon_vcs_url=unknown
+ARG org_opencord_component_chameleon_vcs_ref=unknown
+ARG org_opencord_component_xos_version=unknown
+ARG org_opencord_component_xos_vcs_url=unknown
+ARG org_opencord_component_xos_vcs_ref=unknown
+
+LABEL org.label-schema.schema-version=$org_label_schema_schema_version \
+ org.label-schema.name=$org_label_schema_name \
+ org.label-schema.version=$org_label_schema_version \
+ org.label-schema.vcs-url=$org_label_schema_vcs_url \
+ org.label-schema.vcs-ref=$org_label_schema_vcs_ref \
+ org.label-schema.build-date=$org_label_schema_build_date \
+ org.opencord.vcs-commit-date=$org_opencord_vcs_commit_date \
+ org.opencord.component.chameleon.version=$org_opencord_component_chameleon_version \
+ org.opencord.component.chameleon.vcs-url=$org_opencord_component_chameleon_vcs_url \
+ org.opencord.component.chameleon.vcs-ref=$org_opencord_component_chameleon_vcs_ref \
+ org.opencord.component.xos.version=$org_opencord_component_xos_version \
+ org.opencord.component.xos.vcs-url=$org_opencord_component_xos_vcs_url \
+ org.opencord.component.xos.vcs-ref=$org_opencord_component_xos_vcs_ref
+
+CMD bash -c "cd /opt/xos/synchronizers/vspgwc; ./run-from-api.sh"
\ No newline at end of file
diff --git a/xos/synchronizer/model-deps b/xos/synchronizer/model-deps
new file mode 100644
index 0000000..0967ef4
--- /dev/null
+++ b/xos/synchronizer/model-deps
@@ -0,0 +1 @@
+{}
diff --git a/xos/synchronizer/model_policies/model_policy_vspgwctenant.py b/xos/synchronizer/model_policies/model_policy_vspgwctenant.py
new file mode 100644
index 0000000..974a1f1
--- /dev/null
+++ b/xos/synchronizer/model_policies/model_policy_vspgwctenant.py
@@ -0,0 +1,158 @@
+
+
+# Copyright 2017-present Open Networking Foundation
+#
+# 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 synchronizers.new_base.modelaccessor import *
+from synchronizers.new_base.model_policies.model_policy_tenantwithcontainer import TenantWithContainerPolicy, LeastLoadedNodeScheduler
+from synchronizers.new_base.exceptions import *
+
+class VSPGWCTenantPolicy(TenantWithContainerPolicy):
+ model_name = "VSPGWCTenant"
+
+ def handle_create(self, service_instance):
+ return self.handle_update(service_instance)
+
+ def handle_update(self, service_instance):
+ if (service_instance.link_deleted_count>0) and (not service_instance.provided_links.exists()):
+ self.logger.info("The last provided link has been deleted -- self-destructing.")
+ self.handle_delete(service_instance)
+ if VSPGWCTenant.objects.filter(id=service_instance.id).exists():
+ service_instance.delete()
+ else:
+ self.logger.info("Tenant %s is already deleted" % service_instance)
+ return
+
+ self.manage_container(service_instance)
+
+ def handle_delete(self, service_instance):
+ if service_instance.instance and (not service_instance.instance.deleted):
+ all_service_instances_this_instance = VSPGWCTenant.objects.filter(instance_id=service_instance.instance.id)
+ other_service_instances_this_instance = [x for x in all_service_instances_this_instance if x.id != service_instance.id]
+ if (not other_service_instances_this_instance):
+ self.logger.info("VSPGWCTenant Instance %s is now unused -- deleting" % service_instance.instance)
+ self.delete_instance(service_instance, service_instance.instance)
+ else:
+ self.logger.info("VSPGWCTenant Instance %s has %d other service instances attached" % (service_instance.instance, len(other_service_instances_this_instance)))
+
+ def get_service(self, service_instance):
+ service_name = service_instance.owner.leaf_model_name
+ service_class = globals()[service_name]
+ return service_class.objects.get(id=service_instance.owner.id)
+
+ def find_instance_for_instance_tag(self, instance_tag):
+ tags = Tag.objects.filter(name="instance_tag", value=instance_tag)
+ if tags:
+ return tags[0].content_object
+ return None
+
+ def find_or_make_instance_for_instance_tag(self, service_instance):
+ instance_tag = self.get_instance_tag(service_instance)
+ instance = self.find_instance_for_instance_tag(instance_tag)
+ if instance:
+ if instance.no_sync:
+ # if no_sync is still set, then perhaps we failed while saving it and need to retry.
+ self.save_instance(service_instance, instance)
+ return instance
+
+ desired_image = self.get_image(service_instance)
+ desired_flavor = self.get_flavor(service_instance)
+
+ slice = service_instance.owner.slices.first()
+
+ (node, parent) = LeastLoadedNodeScheduler(slice, label=None).pick()
+
+ assert (slice is not None)
+ assert (node is not None)
+ assert (desired_image is not None)
+ assert (service_instance.creator is not None)
+ assert (node.site_deployment.deployment is not None)
+ assert (desired_image is not None)
+
+ instance = Instance(slice=slice,
+ node=node,
+ image=desired_image,
+ creator=service_instance.creator,
+ deployment=node.site_deployment.deployment,
+ flavor=desired_flavor,
+ isolation=slice.default_isolation,
+ parent=parent)
+
+ self.save_instance(service_instance, instance)
+
+ return instance
+
+ def manage_container(self, service_instance):
+ if service_instance.deleted:
+ return
+
+ if service_instance.instance:
+ # We're good.
+ return
+
+ instance = self.find_or_make_instance_for_instance_tag(service_instance)
+ service_instance.instance = instance
+ # TODO: possible for partial failure here?
+ service_instance.save()
+
+ def delete_instance(self, service_instance, instance):
+ # delete the `instance_tag` tags
+ tags = Tag.objects.filter(service_id=service_instance.owner.id, content_type=instance.self_content_type_id,
+ object_id=instance.id, name="instance_tag")
+ for tag in tags:
+ tag.delete()
+
+ tags = Tag.objects.filter(content_type=instance.self_content_type_id, object_id=instance.id,
+ name="vm_vrouter_tenant")
+ for tag in tags:
+ address_manager_instances = list(ServiceInstance.objects.filter(id=tag.value))
+ tag.delete()
+
+ # TODO: Potential partial failure
+
+ for address_manager_instance in address_manager_instances:
+ self.logger.info("Deleting address_manager_instance %s" % address_manager_instance)
+ address_manager_instance.delete()
+
+ instance.delete()
+
+ def save_instance(self, service_instance, instance):
+ instance.no_sync = True # prevent instance from being synced until we're done with it
+ super(VSPGWCTenantPolicy, self).save_instance(instance)
+
+ try:
+ if instance.isolation in ["container", "container_vm"]:
+ raise Exception("Not supported")
+
+ instance_tag = self.get_instance_tag(service_instance)
+ if instance_tag:
+ tags = Tag.objects.filter(name="instance_tag", value=instance_tag)
+ if not tags:
+ tag = Tag(service=service_instance.owner, content_type=instance.self_content_type_id, object_id=instance.id, name="instance_tag", value=str(instance_tag))
+ tag.save()
+
+ instance.no_sync = False # allow the synchronizer to run now
+ super(VSPGWCTenantPolicy, self).save_instance(instance)
+ except:
+ # need to clean up any failures here
+ raise
+
+ def get_instance_tag(self, service_instance):
+ return '%d'%service_instance.id
+
+ def get_image(self, service_instance):
+ return service_instance.vspgwc_vendor.image
+
+ def get_flavor(self, service_vendor):
+ return service_vendor.vspgwc_vendor.flavor
diff --git a/xos/synchronizer/run-from-api.sh b/xos/synchronizer/run-from-api.sh
new file mode 100755
index 0000000..274a754
--- /dev/null
+++ b/xos/synchronizer/run-from-api.sh
@@ -0,0 +1,15 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+python vspgwc-synchronizer.py
diff --git a/xos/synchronizer/steps/sync_vspgwctenant.py b/xos/synchronizer/steps/sync_vspgwctenant.py
new file mode 100644
index 0000000..3fecbf4
--- /dev/null
+++ b/xos/synchronizer/steps/sync_vspgwctenant.py
@@ -0,0 +1,61 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+import os
+import sys
+from django.db.models import Q, F
+from synchronizers.new_base.modelaccessor import *
+from synchronizers.new_base.SyncInstanceUsingAnsible import SyncInstanceUsingAnsible
+
+parentdir = os.path.join(os.path.dirname(__file__), "..")
+sys.path.insert(0, parentdir)
+
+class SyncVSPGWCTenant(SyncInstanceUsingAnsible):
+ provides = [VSPGWCTenant]
+
+ observes = VSPGWCTenant
+
+ requested_interval = 0
+
+ template_name = "vspgwctenant_playbook.yaml"
+
+ service_key_name = "/opt/xos/configurations/mcord/mcord_private_key"
+
+ def __init__(self, *args, **kwargs):
+ super(SyncVSPGWCTenant, self).__init__(*args, **kwargs)
+
+ # Gets the attributes that are used by the Ansible template but are not
+ # part of the set of default attribtues.
+ #def get_extra_attributes(self, o):
+ # fields = {}
+ # shared_net_id = Network.objects.get(name='shared_network').id
+
+ #try:
+ # fields['sgwc_shared_ip'] = Port.objects.get(network_id=shared_net_id, instance_id=o.instance_id).ip
+ # except Exception:
+ # print '{} does not have an instance'.format(o.name)
+
+ # try:
+ # mme = TenantWithContainer.objects.get(provider_service_id=Service.objects.get(name='vmme').id, subscriber_tenant_id=o.subscriber_tenant_id)
+ # fields['mme_shared_ip'] = Port.objects.get(network_id=shared_net_id, instance_id=mme.instance_id).ip
+ #except Exception:
+ # print '{} does not have a VMME instance'.format(o.subscriber_tenant.name)
+
+ # try:
+ # sgwu = TenantWithContainer.objects.get(provider_service_id=Service.objects.get(name='vspgwu').id, subscriber_tenant_id=o.subscriber_tenant_id)
+ # fields['sgwu_shared_ip'] = Port.objects.get(network_id=shared_net_id, instance_id=sgwu.instance_id).ip
+ # except Exception:
+ # print '{} does not have a VSPGWU instance'.format(o.subscriber_tenant.name)
+
+ # return fields
diff --git a/xos/synchronizer/steps/vspgwctenant_playbook.yaml b/xos/synchronizer/steps/vspgwctenant_playbook.yaml
new file mode 100644
index 0000000..94b1403
--- /dev/null
+++ b/xos/synchronizer/steps/vspgwctenant_playbook.yaml
@@ -0,0 +1,23 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+---
+- hosts: {{ instance_name }}
+ gather_facts: True
+ connection: ssh
+ user: ubuntu
+ sudo: yes
+ vars:
+ roles:
+
diff --git a/xos/synchronizer/vspgwc-synchronizer.py b/xos/synchronizer/vspgwc-synchronizer.py
new file mode 100755
index 0000000..4482d7d
--- /dev/null
+++ b/xos/synchronizer/vspgwc-synchronizer.py
@@ -0,0 +1,32 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+#!/usr/bin/env python
+
+# Runs the standard XOS synchronizer
+
+import importlib
+import os
+import sys
+from xosconfig import Config
+
+config_file = os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/vspgwc_config.yaml')
+
+Config.init(config_file, 'synchronizer-config-schema.yaml')
+observer_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), "../../synchronizers/new_base")
+
+sys.path.append(observer_path)
+mod = importlib.import_module("xos-synchronizer")
+mod.main()
+
diff --git a/xos/synchronizer/vspgwc_config.yaml b/xos/synchronizer/vspgwc_config.yaml
new file mode 100644
index 0000000..54c487e
--- /dev/null
+++ b/xos/synchronizer/vspgwc_config.yaml
@@ -0,0 +1,22 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+name: vspgwc-synchronizer
+accessor:
+ username: xosadmin@opencord.org
+ password: "@/opt/xos/services/vspgwc/credentials/xosadmin@opencord.org"
+dependency_graph: "/opt/xos/synchronizers/vspgwc/model-deps"
+steps_dir: "/opt/xos/synchronizers/vspgwc/steps"
+sys_dir: "/opt/xos/synchronizers/vspgwc/sys"
+model_policies_dir: "/opt/xos/synchronizers/vspgwc/model_policies"
diff --git a/xos/synchronizer/vspgwc_from_api_config b/xos/synchronizer/vspgwc_from_api_config
new file mode 100644
index 0000000..f111fe4
--- /dev/null
+++ b/xos/synchronizer/vspgwc_from_api_config
@@ -0,0 +1,20 @@
+# Sets options for the synchronizer
+[observer]
+name=vspgwc
+dependency_graph=/opt/xos/synchronizers/vspgwc/model-deps
+steps_dir=/opt/xos/synchronizers/vspgwc/steps
+sys_dir=/opt/xos/synchronizers/vspgwc/sys
+#logfile=/var/log/xos_backend.log
+log_file=console
+log_level=debug
+pretend=False
+backoff_disabled=True
+save_ansible_output=True
+proxy_ssh=True
+proxy_ssh_key=/opt/cord_profile/node_key
+proxy_ssh_user=root
+accessor_kind=api
+accessor_password=@/opt/xos/services/vspgwc/credentials/xosadmin@opencord.org
+
+[networking]
+use_vtn=True
\ No newline at end of file
diff --git a/xos/vspgwc-onboard.yaml b/xos/vspgwc-onboard.yaml
new file mode 100644
index 0000000..87060b1
--- /dev/null
+++ b/xos/vspgwc-onboard.yaml
@@ -0,0 +1,35 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+description: Onboard the vspgwc
+
+imports:
+ - custom_types/xos.yaml
+
+topology_template:
+ node_templates:
+ servicecontroller#vspgwc:
+ type: tosca.nodes.ServiceController
+ properties:
+ base_url: file:///opt/xos_services/vspgwc/xos/
+ # The following will concatenate with base_url automatically, if
+ # base_url is non-null.
+ xproto: ./
+ synchronizer: synchronizer/manifest
+ synchronizer_run: vspgwc-synchronizer.py
+ private_key: file:///opt/xos/key_import/mcord_rsa
+ public_key: file:///opt/xos/key_import/mcord_rsa.pub
+
diff --git a/xos/vspgwc.xproto b/xos/vspgwc.xproto
new file mode 100644
index 0000000..4ac90a0
--- /dev/null
+++ b/xos/vspgwc.xproto
@@ -0,0 +1,21 @@
+option name = "vSPGWC";
+option app_label = "vspgwc";
+option kind = "vEPC";
+
+message VSPGWCService (Service){
+ option verbose_name = "Virtual Serving PDN Gateway -- Control Plane Service";
+}
+
+message VSPGWCVendor (XOSBase){
+ option verbose_name = "Virtual Serving PDN Gateway -- Control Plane Vendor";
+
+ required string name = 1 [help_text = "vendor name", max_length = 32, null = False, db_index = False, blank = False];
+ required manytoone image->Image:+ = 2 [help_text = "select image for this vendor", db_index = True, null = False, blank = False];
+ required manytoone flavor->Flavor:+ = 3 [help_text = "select openstack flavor for vendor image", db_index = True, null = False, blank = False];
+}
+
+message VSPGWCTenant (TenantWithContainer){
+ option verbose_name = "Virtual Serving PDN Gateway -- Control Plane ServiceInstance";
+
+ optional manytoone vspgwc_vendor->VSPGWCVendor:vendor_tenants = 1 [help_text = "select vendor of choice, leave blank for slice default", db_index = True, null = True, blank = True];
+}