Initial Commit
Change-Id: I217ec7500eac7c94171f3789704cfd04836bc73a
diff --git a/xos/admin.py b/xos/admin.py
new file mode 100644
index 0000000..5ecf1b4
--- /dev/null
+++ b/xos/admin.py
@@ -0,0 +1,115 @@
+# admin.py - VSGW Django Admin
+
+from core.admin import ReadOnlyAwareAdmin, SliceInline
+from core.middleware import get_request
+from core.models import User
+from django import forms
+from django.contrib import admin
+from services.vsgw.models import *
+
+class VSGWServiceForm(forms.ModelForm):
+
+ class Meta:
+ model = VSGWService
+ fields = '__all__'
+
+ def __init__(self, *args, **kwargs):
+ super(VSgwServiceForm, self).__init__(*args, **kwargs)
+
+ if self.instance:
+ self.fields['service_message'].initial = self.instance.service_message
+
+ def save(self, commit=True):
+ self.instance.service_message = self.cleaned_data.get('service_message')
+ return super(VSGWServiceForm, self).save(commit=commit)
+
+class VSGWServiceAdmin(ReadOnlyAwareAdmin):
+
+ model = VSGWService
+ verbose_name = SERVICE_NAME_VERBOSE
+ verbose_name_plural = SERVICE_NAME_VERBOSE_PLURAL
+ form = VSgwServiceForm
+ inlines = [SliceInline]
+
+ list_display = ('backend_status_icon', 'name', 'service_message', 'enabled')
+ list_display_links = ('backend_status_icon', 'name', 'service_message' )
+
+ fieldsets = [(None, {
+ 'fields': ['backend_status_text', 'name', 'enabled', 'versionNumber', 'service_message', 'description',],
+ 'classes':['suit-tab suit-tab-general',],
+ })]
+
+ readonly_fields = ('backend_status_text', )
+ user_readonly_fields = ['name', 'enabled', 'versionNumber', 'description',]
+
+ extracontext_registered_admins = True
+
+ suit_form_tabs = (
+ ('general', 'Example Service Details', ),
+ ('slices', 'Slices',),
+ )
+
+ suit_form_includes = ((
+ 'top',
+ 'administration'),
+ )
+
+ def get_queryset(self, request):
+ return ExampleService.get_service_objects_by_user(request.user)
+
+admin.site.register(VSGWService, VSGWServiceAdmin)
+
+class VSGWTenantForm(forms.ModelForm):
+
+ class Meta:
+ model = VSGWTenant
+ fields = '__all__'
+
+ creator = forms.ModelChoiceField(queryset=User.objects.all())
+
+ def __init__(self, *args, **kwargs):
+ super(ExampleTenantForm, self).__init__(*args, **kwargs)
+
+ self.fields['kind'].widget.attrs['readonly'] = True
+ self.fields['kind'].initial = SERVICE_NAME
+
+ self.fields['provider_service'].queryset = VSGWService.get_service_objects().all()
+
+ if self.instance:
+ self.fields['creator'].initial = self.instance.creator
+ self.fields['tenant_message'].initial = self.instance.tenant_message
+
+ if (not self.instance) or (not self.instance.pk):
+ self.fields['creator'].initial = get_request().user
+ if VSGWService.get_service_objects().exists():
+ self.fields['provider_service'].initial = VSGWService.get_service_objects().all()[0]
+
+ def save(self, commit=True):
+ self.instance.creator = self.cleaned_data.get('creator')
+ self.instance.tenant_message = self.cleaned_data.get('tenant_message')
+ return super(VSGWTenantForm, self).save(commit=commit)
+
+
+class VSGWTenantAdmin(ReadOnlyAwareAdmin):
+
+ verbose_name = TENANT_NAME_VERBOSE
+ verbose_name_plural = TENANT_NAME_VERBOSE_PLURAL
+
+ list_display = ('id', 'backend_status_icon', 'instance', 'tenant_message')
+ list_display_links = ('backend_status_icon', 'instance', 'tenant_message', 'id')
+
+ fieldsets = [(None, {
+ 'fields': ['backend_status_text', 'kind', 'provider_service', 'instance', 'creator', 'tenant_message'],
+ 'classes': ['suit-tab suit-tab-general'],
+ })]
+
+ readonly_fields = ('backend_status_text', 'instance',)
+
+ form = VSGWTenantForm
+
+ suit_form_tabs = (('general', 'Details'),)
+
+ def get_queryset(self, request):
+ return VSGWTenant.get_tenant_objects_by_user(request.user)
+
+admin.site.register(VSGWTenant, VSGWTenantAdmin)
\ No newline at end of file
diff --git a/xos/macros.m4 b/xos/macros.m4
new file mode 100644
index 0000000..1f48f10
--- /dev/null
+++ b/xos/macros.m4
@@ -0,0 +1,84 @@
+# 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
+
diff --git a/xos/make_synchronizer_manifest.sh b/xos/make_synchronizer_manifest.sh
new file mode 100644
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..39dfa7f
--- /dev/null
+++ b/xos/models.py
@@ -0,0 +1,49 @@
+# models.py - vSGW Models
+
+SERVICE_NAME = 'vsgw'
+SERVICE_NAME_VERBOSE = 'Virtual SGW Service'
+SERVICE_NAME_VERBOSE_PLURAL = 'Virtual SGW Services'
+TENANT_NAME_VERBOSE = 'Virtual SGW Tenant'
+TENANT_NAME_VERBOSE_PLURAL = 'Virtual SGW Tenants'
+
+class VSGWService(Service):
+
+ KIND = SERVICE_NAME
+
+ class Meta:
+ app_label = SERVICE_NAME
+ verbose_name = SERVICE_NAME_VERBOSE
+
+ service_message = models.CharField(max_length=254, help_text="Service Message to Display")
+
+class VSGWTenant(TenantWithContainer):
+
+ KIND = SERVICE_NAME
+
+ class Meta:
+ verbose_name = TENANT_NAME_VERBOSE
+
+ tenant_message = models.CharField(max_length=254, help_text="Tenant Message to Display")
+
+ def __init__(self, *args, **kwargs):
+ vsgw_service = VSGWService.get_service_objects().all()
+ if vsgw_service:
+ self._meta.get_field('provider_service').default = vsgw_service[0].id
+ super(ExampleTenant, self).__init__(*args, **kwargs)
+
+ def save(self, *args, **kwargs):
+ super(VSGWTenant, self).save(*args, **kwargs)
+ model_policy_exampletenant(self.pk)
+
+ def delete(self, *args, **kwargs):
+ self.cleanup_container()
+ super(VSGWTenant, self).delete(*args, **kwargs)
+
+
+def model_policy_exampletenant(pk):
+ with transaction.atomic():
+ tenant = VSGWTenant.objects.select_for_update().filter(pk=pk)
+ if not tenant:
+ return
+ tenant = tenant[0]
+ tenant.manage_container()
\ No newline at end of file
diff --git a/xos/synchronizer/manifest b/xos/synchronizer/manifest
new file mode 100644
index 0000000..ecf2f26
--- /dev/null
+++ b/xos/synchronizer/manifest
@@ -0,0 +1,10 @@
+manifest
+steps/sync_vsgwtenant.py
+steps/roles/install_apache/tasks/main.yml
+steps/roles/create_index/templates/index.html.j2
+steps/roles/create_index/tasks/main.yml
+steps/vsgwtenant_playbook.yaml
+vsgwservice-synchronizer.py
+model-deps
+run.sh
+vsgservice_config
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.sh b/xos/synchronizer/run.sh
new file mode 100755
index 0000000..da12ee3
--- /dev/null
+++ b/xos/synchronizer/run.sh
@@ -0,0 +1,2 @@
+export XOS_DIR=/opt/xos
+python vsgwservice-synchronizer.py -C $XOS_DIR/synchronizers/vsgw/vsgwservice_config
diff --git a/xos/synchronizer/steps/exampletenant_playbook.yaml b/xos/synchronizer/steps/exampletenant_playbook.yaml
new file mode 100644
index 0000000..9ec8937
--- /dev/null
+++ b/xos/synchronizer/steps/exampletenant_playbook.yaml
@@ -0,0 +1,16 @@
+---
+# vsgwtenant_playbook
+
+- hosts: "{{ instance_name }}"
+ connection: ssh
+ user: ubuntu
+ sudo: yes
+ gather_facts: no
+ vars:
+ - tenant_message: "{{ tenant_message }}"
+ - service_message: "{{ service_message }}"
+
+ roles:
+ - install_apache
+ - create_index
+
diff --git a/xos/synchronizer/steps/roles/create_index/tasks/main.yml b/xos/synchronizer/steps/roles/create_index/tasks/main.yml
new file mode 100644
index 0000000..91c6029
--- /dev/null
+++ b/xos/synchronizer/steps/roles/create_index/tasks/main.yml
@@ -0,0 +1,7 @@
+---
+
+- name: Write index.html file to apache document root
+ template:
+ src=index.html.j2
+ dest=/var/www/html/index.html
+
diff --git a/xos/synchronizer/steps/roles/create_index/templates/index.html.j2 b/xos/synchronizer/steps/roles/create_index/templates/index.html.j2
new file mode 100644
index 0000000..9c3e8fc
--- /dev/null
+++ b/xos/synchronizer/steps/roles/create_index/templates/index.html.j2
@@ -0,0 +1,4 @@
+VSGWService
+ Service Message: "{{ service_message }}"
+ Tenant Message: "{{ tenant_message }}"
+
diff --git a/xos/synchronizer/steps/roles/install_apache/tasks/main.yml b/xos/synchronizer/steps/roles/install_apache/tasks/main.yml
new file mode 100644
index 0000000..d9a155c
--- /dev/null
+++ b/xos/synchronizer/steps/roles/install_apache/tasks/main.yml
@@ -0,0 +1,7 @@
+---
+
+- name: Install apache using apt
+ apt:
+ name=apache2
+ update_cache=yes
+
diff --git a/xos/synchronizer/steps/sync_vsgwtenant.py b/xos/synchronizer/steps/sync_vsgwtenant.py
new file mode 100644
index 0000000..38f9969
--- /dev/null
+++ b/xos/synchronizer/steps/sync_vsgwtenant.py
@@ -0,0 +1,55 @@
+import os
+import sys
+from django.db.models import Q, F
+from services.vsgwservice.models import VSGWService, VSGWTenant
+from synchronizers.base.SyncInstanceUsingAnsible import SyncInstanceUsingAnsible
+
+parentdir = os.path.join(os.path.dirname(__file__), "..")
+sys.path.insert(0, parentdir)
+
+class SyncVSGWTenant(SyncInstanceUsingAnsible):
+
+ provides = [VSGWTenant]
+
+ observes = VSGWTenant
+
+ requested_interval = 0
+
+ template_name = "vsgwtenant_playbook.yaml"
+
+ service_key_name = "/opt/xos/synchronizers/vsgwservice/vsgwservice_private_key"
+
+ def __init__(self, *args, **kwargs):
+ super(SyncVSGWTenant, self).__init__(*args, **kwargs)
+
+ def fetch_pending(self, deleted):
+
+ if (not deleted):
+ objs = VSGWTenant.get_tenant_objects().filter(
+ Q(enacted__lt=F('updated')) | Q(enacted=None), Q(lazy_blocked=False))
+ else:
+ # If this is a deletion we get all of the deleted tenants..
+ objs = VSGWTenant.get_deleted_tenant_objects()
+
+ return objs
+
+ def get_exampleservice(self, o):
+ if not o.provider_service:
+ return None
+
+ vsgwservice = VSGWService.get_service_objects().filter(id=o.provider_service.id)
+
+ if not vsgwservice:
+ return None
+
+ return vsgwservice[0]
+
+ # Gets the attributes that are used by the Ansible template but are not
+ # part of the set of default attributes.
+ def get_extra_attributes(self, o):
+ fields = {}
+ fields['tenant_message'] = o.tenant_message
+ vsgwservice = self.get_vsgwservice(o)
+ fields['service_message'] = vsgwservice.service_message
+ return fields
+
diff --git a/xos/synchronizer/vsgwservice-synchronizer.py b/xos/synchronizer/vsgwservice-synchronizer.py
new file mode 100644
index 0000000..90d2c98
--- /dev/null
+++ b/xos/synchronizer/vsgwservice-synchronizer.py
@@ -0,0 +1,14 @@
+#!/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/base")
+sys.path.append(synchronizer_path)
+mod = importlib.import_module("xos-synchronizer")
+mod.main()
+
diff --git a/xos/synchronizer/vsgwservice_config b/xos/synchronizer/vsgwservice_config
new file mode 100644
index 0000000..47c9354
--- /dev/null
+++ b/xos/synchronizer/vsgwservice_config
@@ -0,0 +1,24 @@
+# Required by XOS
+[db]
+name=xos
+user=postgres
+password=password
+host=localhost
+port=5432
+
+# Required by XOS
+[api]
+nova_enabled=True
+
+# Sets options for the synchronizer
+[observer]
+name=vsgwservice
+dependency_graph=/opt/xos/synchronizers/vsgwservice/model-deps
+steps_dir=/opt/xos/synchronizers/vsgwservice/steps
+sys_dir=/opt/xos/synchronizers/vsgwservice/sys
+logfile=/var/log/xos_backend.log
+pretend=False
+backoff_disabled=True
+save_ansible_output=True
+proxy_ssh=False
+
diff --git a/xos/tosca/resources/vsgwservice.py b/xos/tosca/resources/vsgwservice.py
new file mode 100644
index 0000000..6289ffd
--- /dev/null
+++ b/xos/tosca/resources/vsgwservice.py
@@ -0,0 +1,38 @@
+import os
+import pdb
+import sys
+import tempfile
+sys.path.append("/opt/tosca")
+from translator.toscalib.tosca_template import ToscaTemplate
+import pdb
+
+from core.models import Service,User,CoarseTenant
+from services.vsgwservice.models import VSGWService
+
+from xosresource import XOSResource
+
+class XOSVSGWService(XOSResource):
+ provides = "tosca.nodes.VSGWService"
+ xos_model = VSGWService
+ copyin_props = ["view_url", "icon_url", "enabled", "published", "public_key", "private_key_fn", "versionNumber", "service_message"]
+
+ def postprocess(self, obj):
+ for provider_service_name in self.get_requirements("tosca.relationships.TenantOfService"):
+ provider_service = self.get_xos_object(VSGWService, name=provider_service_name)
+
+ existing_tenancy = CoarseTenant.get_tenant_objects().filter(provider_service = provider_service, subscriber_service = obj)
+ if existing_tenancy:
+ self.info("Tenancy relationship from %s to %s already exists" % (str(obj), str(provider_service)))
+ else:
+ tenancy = CoarseTenant(provider_service = provider_service,
+ subscriber_service = obj)
+ tenancy.save()
+
+ self.info("Created Tenancy relationship from %s to %s" % (str(obj), str(provider_service)))
+
+ def can_delete(self, obj):
+ if obj.slices.exists():
+ self.info("Service %s has active slices; skipping delete" % obj.name)
+ return False
+ return super(XOSVSGWService, self).can_delete(obj)
+
diff --git a/xos/tosca/resources/vsgwtenant.py b/xos/tosca/resources/vsgwtenant.py
new file mode 100644
index 0000000..29ea5f6
--- /dev/null
+++ b/xos/tosca/resources/vsgwtenant.py
@@ -0,0 +1,36 @@
+import importlib
+import os
+import pdb
+import sys
+import tempfile
+sys.path.append("/opt/tosca")
+from translator.toscalib.tosca_template import ToscaTemplate
+from core.models import Tenant, Service
+from services.vsgwservice.models import *
+
+from xosresource import XOSResource
+
+class XOSVSGWTenant(XOSResource):
+ provides = "tosca.nodes.ExampleTenant"
+ xos_model = VSGWTenant
+ name_field = "service_specific_id"
+ copyin_props = ("tenant_message",)
+
+ def get_xos_args(self, throw_exception=True):
+ args = super(XOSVSGWTenant, self).get_xos_args()
+
+ # ExampleTenant must always have a provider_service
+ 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)
+ return VSGWTenant.get_tenant_objects().filter(provider_service=args["provider_service"], service_specific_id=args["service_specific_id"])
+ return []
+
+ def can_delete(self, obj):
+ return super(XOSVSGWTenant, self).can_delete(obj)
+
diff --git a/xos/vSGW-onboard.yaml b/xos/vSGW-onboard.yaml
new file mode 100644
index 0000000..de66ae8
--- /dev/null
+++ b/xos/vSGW-onboard.yaml
@@ -0,0 +1,26 @@
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+description: Onboard the vSGW
+
+imports:
+ - custom_types/xos.yaml
+
+topology_template:
+ node_templates:
+ VSGWservice:
+ type: tosca.nodes.ServiceController
+ properties:
+ base_url: file:///opt/xos_services/vSGW/xos/
+ # The following will concatenate with base_url automatically, if
+ # base_url is non-null.
+ models: models.py
+ admin: admin.py
+ synchronizer: synchronizer/manifest
+ synchronizer_run: vsgw-synchronizer.py
+ tosca_custom_types: vsgw.yaml
+ tosca_resource: tosca/resources/vsgwservice.py, tosca/resources/vsgwtenant.py
+ rest_service: api/service/vsgwservice.py
+ rest_tenant: api/tenant/vsgwtenant.py
+ private_key: file:///opt/xos/key_import/vsgw_rsa
+ public_key: file:///opt/xos/key_import/vsgw_rsa.pub
+
diff --git a/xos/vsgwservice.yaml b/xos/vsgwservice.yaml
new file mode 100644
index 0000000..e8223fc
--- /dev/null
+++ b/xos/vsgwservice.yaml
@@ -0,0 +1,96 @@
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+# 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
+
+
+
+
+
+node_types:
+ tosca.nodes.VSGWService:
+ derived_from: tosca.nodes.Root
+ description: >
+ Example 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.
+ service_message:
+ type: string
+ required: false
+
+ tosca.nodes.VSGWTenant:
+ derived_from: tosca.nodes.Root
+ description: >
+ A Tenant of the vsgw service
+ 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
+ tenant_message:
+ type: string
+ required: false
+