add vPGWU services
Change-Id: Ide9597e59f124dc4b43f653c6cc301ff19464450
diff --git a/xos/make_synchronizer_manifest.sh b/xos/make_synchronizer_manifest.sh
new file mode 100755
index 0000000..4058982
--- /dev/null
+++ b/xos/make_synchronizer_manifest.sh
@@ -0,0 +1,2 @@
+#! /bin/bash
+find synchronizer -type f | cut -b 14- > synchronizer/manifest
diff --git a/xos/models.py b/xos/models.py
new file mode 100644
index 0000000..4da52cb
--- /dev/null
+++ b/xos/models.py
@@ -0,0 +1,58 @@
+from core.models.plcorebase import *
+from models_decl import VPGWUService_decl
+from models_decl import VPGWUTenant_decl
+
+from django.db import models
+from core.models import Service, PlCoreBase, Slice, Instance, Tenant, TenantWithContainer, Node, Image, User, Flavor, NetworkParameter, NetworkParameterType, Port, AddressPool, SlicePrivilege, SitePrivilege
+from core.models.plcorebase import StrippedCharField
+import os
+from django.db import models, transaction
+from django.forms.models import model_to_dict
+from django.db.models import *
+from operator import itemgetter, attrgetter, methodcaller
+from core.models import Tag
+from core.models.service import LeastLoadedNodeScheduler
+import traceback
+from xos.exceptions import *
+from sets import Set
+from xos.config import Config
+from django.contrib.contenttypes.models import ContentType
+from django.contrib.contenttypes.fields import GenericForeignKey
+
+class VPGWUService(VPGWUService_decl):
+ class Meta:
+ proxy = True
+
+class VPGWUTenant(VPGWUTenant_decl):
+ class Meta:
+ proxy = True
+
+ def __init__(self, *args, **kwargs):
+ vpgwuservice = VPGWUService.get_service_objects().all()
+ # When the tenant is created the default service in the form is set
+ # to be the first created HelloWorldServiceComplete
+ if vpgwuservice:
+ self._meta.get_field(
+ "provider_service").default = vpgwuservice[0].id
+ super(VPGWUTenant, self).__init__(*args, **kwargs)
+
+ def save(self, *args, **kwargs):
+ # Update the instance that was created for this tenant
+ super(VPGWUTenant, self).save(*args, **kwargs)
+ model_policy_vpgwutenant(self.pk)
+
+ def delete(self, *args, **kwargs):
+ # Delete the instance that was created for this tenant
+ self.cleanup_container()
+ super(VPGWUTenant, self).delete(*args, **kwargs)
+
+def model_policy_vpgwutenant(pk):
+ # This section of code is atomic to prevent race conditions
+ with transaction.atomic():
+ # We find all of the tenants that are waiting to update
+ tenant = VPGWUTenant.objects.select_for_update().filter(pk=pk)
+ if not tenant:
+ return
+ # Since this code is atomic it is safe to always use the first tenant
+ tenant = tenant[0]
+ tenant.manage_container()
diff --git a/xos/synchronizer/Dockerfile.synchronizer b/xos/synchronizer/Dockerfile.synchronizer
new file mode 100644
index 0000000..7a9fd9f
--- /dev/null
+++ b/xos/synchronizer/Dockerfile.synchronizer
@@ -0,0 +1,40 @@
+# xosproject/vpgwu-synchronizer
+
+FROM xosproject/xos-synchronizer-base:candidate
+
+COPY . /opt/xos/synchronizers/vpgwu
+
+ENTRYPOINT []
+
+WORKDIR "/opt/xos/synchronizers/vpgwu"
+
+# Label image
+ARG org_label_schema_schema_version=1.0
+ARG org_label_schema_name=vpgwu-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/vpgwu; ./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/run-from-api.sh b/xos/synchronizer/run-from-api.sh
new file mode 100755
index 0000000..9d7ae4f
--- /dev/null
+++ b/xos/synchronizer/run-from-api.sh
@@ -0,0 +1,2 @@
+export XOS_DIR=/opt/xos
+python vpgwu-synchronizer.py -C $XOS_DIR/synchronizers/vpgwu/vpgwu_from_api_config
diff --git a/xos/synchronizer/steps/sync_vpgwutenant.py b/xos/synchronizer/steps/sync_vpgwutenant.py
new file mode 100644
index 0000000..b22438c
--- /dev/null
+++ b/xos/synchronizer/steps/sync_vpgwutenant.py
@@ -0,0 +1,44 @@
+import os
+import sys
+from django.db.models import Q, F
+from synchronizers.new_base.SyncInstanceUsingAnsible import SyncInstanceUsingAnsible
+from synchronizers.new_base.modelaccessor import *
+
+parentdir = os.path.join(os.path.dirname(__file__), "..")
+sys.path.insert(0, parentdir)
+
+class SyncVPGWUTenant(SyncInstanceUsingAnsible):
+
+ provides = [VPGWUTenant]
+
+ observes = VPGWUTenant
+
+ requested_interval = 0
+
+ template_name = "vpgwutenant_playbook.yaml"
+
+ service_key_name = "/opt/xos/configurations/mcord/mcord_private_key"
+
+ def __init__(self, *args, **kwargs):
+ super(SyncVPGWUTenant, self).__init__(*args, **kwargs)
+
+ def fetch_pending(self, deleted):
+
+ if (not deleted):
+ objs = VPGWUTenant.get_tenant_objects().filter(
+ Q(enacted__lt=F('updated')) | Q(enacted=None), Q(lazy_blocked=False))
+ else:
+
+ objs = VPGWUTenant.get_deleted_tenant_objects()
+
+ return objs
+
+ def get_extra_attributes(self, o):
+ fields = {}
+ fields['display_message'] = o.display_message
+ fields['s5s8_pgw_tag'] = o.s5s8_pgw_tag
+ fields['image_name'] = o.image_name
+ return fields
+
+ def delete_record(self, port):
+ pass
diff --git a/xos/synchronizer/steps/vpgwutenant_playbook.yaml b/xos/synchronizer/steps/vpgwutenant_playbook.yaml
new file mode 100644
index 0000000..455290c
--- /dev/null
+++ b/xos/synchronizer/steps/vpgwutenant_playbook.yaml
@@ -0,0 +1,13 @@
+---
+- hosts: {{ instance_name }}
+ gather_facts: False
+ connection: ssh
+ user: ubuntu
+ become: yes
+ tasks:
+
+ - name: write message
+ shell: echo "{{ display_message }}" > /var/tmp/index.html
+
+ - name: setup s5s8_pgw interface config
+ shell: ./start_3gpp_int.sh eth1 {{ s5s8_pgw_tag }} {{ s5s8_pgw_ip }}/24
diff --git a/xos/synchronizer/vpgwu-synchronizer.py b/xos/synchronizer/vpgwu-synchronizer.py
new file mode 100755
index 0000000..6db012f
--- /dev/null
+++ b/xos/synchronizer/vpgwu-synchronizer.py
@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+
+# Runs the standard XOS synchronizer
+
+import importlib
+import os
+import sys
+
+synchronizer_path = os.path.join(os.path.dirname(
+ os.path.realpath(__file__)), "../../synchronizers/new_base")
+sys.path.append(synchronizer_path)
+mod = importlib.import_module("xos-synchronizer")
+mod.main()
diff --git a/xos/synchronizer/vpgwu_from_api_config b/xos/synchronizer/vpgwu_from_api_config
new file mode 100644
index 0000000..baaaecd
--- /dev/null
+++ b/xos/synchronizer/vpgwu_from_api_config
@@ -0,0 +1,21 @@
+# Sets options for the synchronizer
+[observer]
+name=vpgwu
+dependency_graph=/opt/xos/synchronizers/vpgwu/model-deps
+steps_dir=/opt/xos/synchronizers/vpgwu/steps
+sys_dir=/opt/xos/synchronizers/vpgwu/sys
+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
+enable_watchers=True
+accessor_kind=api
+accessor_password=@/opt/xos/services/vpgwu/credentials/xosadmin@opencord.org
+#required_models=VPGWUService, VPGWUTenant, ServiceDependency
+[networking]
+use_vtn=True
+
diff --git a/xos/tosca/custom_types/macros.m4 b/xos/tosca/custom_types/macros.m4
new file mode 100644
index 0000000..78ef38c
--- /dev/null
+++ b/xos/tosca/custom_types/macros.m4
@@ -0,0 +1,83 @@
+# Note: Tosca derived_from isn't working the way I think it should, it's not
+# inheriting from the parent template. Until we get that figured out, use
+# m4 macros do our inheritance
+
+define(xos_base_props,
+ no-delete:
+ type: boolean
+ default: false
+ description: Do not allow Tosca to delete this object
+ no-create:
+ type: boolean
+ default: false
+ description: Do not allow Tosca to create this object
+ no-update:
+ type: boolean
+ default: false
+ description: Do not allow Tosca to update this object
+ replaces:
+ type: string
+ required: false
+ descrption: Replaces/renames this object)
+# Service
+define(xos_base_service_caps,
+ scalable:
+ type: tosca.capabilities.Scalable
+ service:
+ type: tosca.capabilities.xos.Service)
+define(xos_base_service_props,
+ kind:
+ type: string
+ default: generic
+ description: Type of service.
+ view_url:
+ type: string
+ required: false
+ description: URL to follow when icon is clicked in the Service Directory.
+ icon_url:
+ type: string
+ required: false
+ description: ICON to display in the Service Directory.
+ enabled:
+ type: boolean
+ default: true
+ published:
+ type: boolean
+ default: true
+ description: If True then display this Service in the Service Directory.
+ public_key:
+ type: string
+ required: false
+ description: Public key to install into Instances to allows Services to SSH into them.
+ private_key_fn:
+ type: string
+ required: false
+ description: Location of private key file
+ versionNumber:
+ type: string
+ required: false
+ description: Version number of Service.)
+# Subscriber
+define(xos_base_subscriber_caps,
+ subscriber:
+ type: tosca.capabilities.xos.Subscriber)
+define(xos_base_subscriber_props,
+ kind:
+ type: string
+ default: generic
+ description: Kind of subscriber
+ service_specific_id:
+ type: string
+ required: false
+ description: Service specific ID opaque to XOS but meaningful to service)
+define(xos_base_tenant_props,
+ kind:
+ type: string
+ default: generic
+ description: Kind of tenant
+ service_specific_id:
+ type: string
+ required: false
+ description: Service specific ID opaque to XOS but meaningful to service)
+
+# end m4 macros
\ No newline at end of file
diff --git a/xos/tosca/custom_types/vpgwu.m4 b/xos/tosca/custom_types/vpgwu.m4
new file mode 100644
index 0000000..b94b377
--- /dev/null
+++ b/xos/tosca/custom_types/vpgwu.m4
@@ -0,0 +1,33 @@
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+# compile this with "m4 vpgwu.m4 > vpgwu.yaml"
+
+# include macros
+include(macros.m4)
+
+node_types:
+ tosca.nodes.VPGWUService:
+ derived_from: tosca.nodes.Root
+ description: >
+ CORD - The vPGWU Service
+ capabilities:
+ xos_base_service_caps
+ properties:
+ xos_base_props
+ xos_base_service_props
+
+ tosca.nodes.VPGWUTenant:
+ derived_from: tosca.nodes.Root
+ description: >
+ CORD - The vPGWU Tenant
+ properties:
+ xos_base_tenant_props
+ display_message:
+ type: string
+ required: false
+ s5s8_pgw_tag:
+ type: string
+ required: false
+ image_name:
+ type: string
+ required: false
diff --git a/xos/tosca/custom_types/vpgwu.yaml b/xos/tosca/custom_types/vpgwu.yaml
new file mode 100644
index 0000000..af366e8
--- /dev/null
+++ b/xos/tosca/custom_types/vpgwu.yaml
@@ -0,0 +1,101 @@
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+# compile this with "m4 vpgwu.m4 > vpgwu.yaml"
+
+# include macros
+# Note: Tosca derived_from isn't working the way I think it should, it's not
+# inheriting from the parent template. Until we get that figured out, use
+# m4 macros do our inheritance
+
+
+# Service
+
+
+# Subscriber
+
+
+
+
+# end m4 macros
+
+node_types:
+ tosca.nodes.VPGWUService:
+ derived_from: tosca.nodes.Root
+ description: >
+ CORD - The vPGWU Service
+ capabilities:
+ scalable:
+ type: tosca.capabilities.Scalable
+ service:
+ type: tosca.capabilities.xos.Service
+ properties:
+ no-delete:
+ type: boolean
+ default: false
+ description: Do not allow Tosca to delete this object
+ no-create:
+ type: boolean
+ default: false
+ description: Do not allow Tosca to create this object
+ no-update:
+ type: boolean
+ default: false
+ description: Do not allow Tosca to update this object
+ replaces:
+ type: string
+ required: false
+ descrption: Replaces/renames this object
+ kind:
+ type: string
+ default: generic
+ description: Type of service.
+ view_url:
+ type: string
+ required: false
+ description: URL to follow when icon is clicked in the Service Directory.
+ icon_url:
+ type: string
+ required: false
+ description: ICON to display in the Service Directory.
+ enabled:
+ type: boolean
+ default: true
+ published:
+ type: boolean
+ default: true
+ description: If True then display this Service in the Service Directory.
+ public_key:
+ type: string
+ required: false
+ description: Public key to install into Instances to allows Services to SSH into them.
+ private_key_fn:
+ type: string
+ required: false
+ description: Location of private key file
+ versionNumber:
+ type: string
+ required: false
+ description: Version number of Service.
+
+ tosca.nodes.VPGWUTenant:
+ derived_from: tosca.nodes.Root
+ description: >
+ CORD - The vPGWU Tenant
+ properties:
+ kind:
+ type: string
+ default: generic
+ description: Kind of tenant
+ service_specific_id:
+ type: string
+ required: false
+ description: Service specific ID opaque to XOS but meaningful to service
+ display_message:
+ type: string
+ required: false
+ s5s8_pgw_tag:
+ type: string
+ required: false
+ image_name:
+ type: string
+ required: false
diff --git a/xos/tosca/resources/vpgwuservice.py b/xos/tosca/resources/vpgwuservice.py
new file mode 100644
index 0000000..fbfad88
--- /dev/null
+++ b/xos/tosca/resources/vpgwuservice.py
@@ -0,0 +1,7 @@
+from service import XOSService
+from services.vpgwu.models import VPGWUService
+
+class XOSVPGWUService(XOSService):
+ provides = "tosca.nodes.VPGWUService"
+ xos_model = VPGWUService
+ copyin_props = ["view_url", "icon_url", "enabled", "published", "public_key", "private_key_fn", "versionNumber"]
\ No newline at end of file
diff --git a/xos/tosca/resources/vpgwutenant.py b/xos/tosca/resources/vpgwutenant.py
new file mode 100644
index 0000000..06cbd42
--- /dev/null
+++ b/xos/tosca/resources/vpgwutenant.py
@@ -0,0 +1,31 @@
+from xosresource import XOSResource
+from core.models import Tenant, Service
+from services.vpgwu.models import VPGWUTenant
+
+class XOSVPGWUTenant(XOSResource):
+ provides = "tosca.nodes.VPGWUTenant"
+ xos_model = VPGWUTenant
+ name_field = None
+ copyin_props = ["s5s8_pgw_tag", "display_message", "image_name"]
+
+ def get_xos_args(self, throw_exception=True):
+ args = super(XOSVPGWUTenant, self).get_xos_args()
+
+ provider_name = self.get_requirement("tosca.relationships.TenantOfService", throw_exception=True)
+ if provider_name:
+ args["provider_service"] = self.get_xos_object(Service, throw_exception=True, name=provider_name)
+
+ return args
+
+ def get_existing_objs(self):
+ args = self.get_xos_args(throw_exception=False)
+ provider_service = args.get("provider", None)
+ if provider_service:
+ return [self.get_xos_object(provider_service=provider_service)]
+ return []
+
+ def postprocess(self, obj):
+ pass
+
+ def can_delete(self, obj):
+ return super(XOSVPGWUTenant, self).can_delete(obj)
diff --git a/xos/vpgwu-onboard.yaml b/xos/vpgwu-onboard.yaml
new file mode 100644
index 0000000..69af2c5
--- /dev/null
+++ b/xos/vpgwu-onboard.yaml
@@ -0,0 +1,23 @@
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+description: Onboard the vPGWU service
+
+imports:
+ - custom_types/xos.yaml
+
+topology_template:
+ node_templates:
+ servicecontroller#vpgwu:
+ type: tosca.nodes.ServiceController
+ properties:
+ base_url: file:///opt/xos_services/vpgwu/xos/
+ # The following will concatenate with base_url automatically, if
+ # base_url is non-null.
+ xproto: ./
+ synchronizer: synchronizer/manifest
+ synchronizer_run: vpgwu-synchronizer.py
+ tosca_custom_types: tosca/custom_types/vpgwu.yaml
+ tosca_resource: tosca/resources/vpgwuservice.py, tosca/resources/vpgwutenant.py
+ private_key: file:///opt/xos/key_import/mcord_rsa
+ public_key: file:///opt/xos/key_import/mcord_rsa.pub
+
diff --git a/xos/vpgwu.xproto b/xos/vpgwu.xproto
new file mode 100644
index 0000000..cd77594
--- /dev/null
+++ b/xos/vpgwu.xproto
@@ -0,0 +1,18 @@
+option name = "vPGWU";
+option verbose_name = "Virtual Packet Gateway -- Control";
+option app_label = "vpgwu";
+option kind = "vEPC";
+option legacy = "True";
+
+message VPGWUService (Service) {
+ option name = "VPGWUService";
+ option verbose_name = "Virtual Packet Gateway -- User Plane Service";
+}
+
+message VPGWUTenant (TenantWithContainer) {
+ option name = "VPGWUTenant";
+ option verbose_name = "Virtual Packet Gateway -- User Plane Tenant";
+ optional string display_message = 1 [db_index = False, max_length = 1024, null = True, blank = False, default = "New vPGWU Component"];
+ optional string s5s8_pgw_tag = 2 [db_index = False, max_length = 1024, null = True, content = "stripped", blank = False, default = "300"];
+ optional string image_name = 3 [db_index = False, max_length = 1024, null = True, content = "stripped", blank = False, default = "default"];
+}