[CORD-1445] Refactored vPGWC for CORD-3.0
Change-Id: I6024d0e4eae62ffbce84d6deef0be5c8918f7986
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..e43b0f9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..ded4f63
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2016 Open Networking Laboratory
+
+ 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.
diff --git a/xos/__init__.py b/xos/__init__.py
deleted file mode 100644
index e69de29..0000000
--- a/xos/__init__.py
+++ /dev/null
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/models.py b/xos/models.py
index 74b10b9..7799183 100644
--- a/xos/models.py
+++ b/xos/models.py
@@ -1,4 +1,4 @@
-from core.models import Service, PlCoreBase, Slice, Instance, Tenant, TenantWithContainer, Node, Image, User, Flavor, Subscriber, NetworkParameter, NetworkParameterType, AddressPool, Port
+from core.models import Service, PlCoreBase, Slice, Instance, Tenant, TenantWithContainer, Node, Image, User, Flavor, NetworkParameter, NetworkParameterType, AddressPool, Port
from core.models.plcorebase import StrippedCharField
import os
from django.db import models, transaction
@@ -12,55 +12,16 @@
from core.models import SlicePrivilege, SitePrivilege
from sets import Set
from xos.config import Config
+from models_decl import *
-MCORD_KIND = "EPC"
-SERVICE_NAME_VERBOSE = 'VPGWC Service'
-SERVICE_NAME_VERBOSE_PLURAL = 'VPGWC Services'
-TENANT_NAME_VERBOSE = 'VPGWC Service Tenant'
-TENANT_NAME_VERBOSE_PLURAL = 'VPGWC Service Tenants'
-
-MCORD_USE_VTN = getattr(Config(), "networking_use_vtn", False)
-vbbu_net_types = ("s1u", "s1mme", "rru")
-vpgwc_net_types = ("s5s8")
-# The class to represent the service. Most of the service logic is given for us
-# in the Service class but, we have some configuration that is specific for
-# this example.
-class VPGWCService(Service):
- KIND = MCORD_KIND
-
+class VPGWCService (VPGWCService_decl):
class Meta:
- # When the proxy field is set to True the model is represented as
- # it's superclass in the database, but we can still change the python
- # behavior. In this case HelloWorldServiceComplete is a Service in the
- # database.
- proxy = True
- # The name used to find this service, all directories are named this
- app_label = "vpgwc"
- verbose_name = "vPGWC Service"
+ proxy = True
-# This is the class to represent the tenant. Most of the logic is given to use
-# in TenantWithContainer, however there is some configuration and logic that
-# we need to define for this example.
-class VPGWCTenant(TenantWithContainer):
-
-
- # The kind of the service is used on forms to differentiate this service
- # from the other services.
- KIND = MCORD_KIND
+class VPGWCTenant (VPGWCTenant_decl):
class Meta:
- # Same as a above, HelloWorldTenantComplete is represented as a
- # TenantWithContainer, but we change the python behavior.
- proxy = True
- verbose_name = "VPGWC Service Component"
+ proxy = True
- # Ansible requires that the sync_attributes field contain nat_ip and nat_mac
- # these will be used to determine where to SSH to for ansible.
- # Getters must be defined for every attribute specified here.
- sync_attributes = ("s5s8_pgw_ip", "s5s8_pgw_mac")
-
- # default_attributes is used cleanly indicate what the default values for
- # the fields are.
- default_attributes = {"display_message": "New vPGWC Component", "s5s8_pgw_tag": "300", "image_name": "default"}
def __init__(self, *args, **kwargs):
pgwc_services = VPGWCService.get_service_objects().all()
# When the tenant is created the default service in the form is set
@@ -88,7 +49,6 @@
# This call needs to happen so that an instance is created for this
# tenant is created in the slice. One instance is created per tenant.
model_policy_mcord_servicecomponent(self.pk)
-
# def save_instance(self, instance):
# with transaction.atomic():
# super(VPGWCTenant, self).save_instance(instance)
@@ -101,7 +61,7 @@
# port.set_parameter("neutron_port_name", "stag-%s" % self.s5s8_pgw_tag)
# port.save()
# else:
-# return True
+# return True
def save_instance(self, instance):
with transaction.atomic():
@@ -138,24 +98,19 @@
def manage_container(self):
from core.models import Instance, Flavor
-
if self.deleted:
return
-
# For container or container_vm isolation, use what TenantWithCotnainer
# provides us
slice = self.get_slice()
if slice.default_isolation in ["container_vm", "container"]:
super(VPGWCTenant,self).manage_container()
return
-
if not self.s5s8_pgw_tag:
raise XOSConfigurationError("S5S8_PGW_TAG is missed")
-
if self.instance:
# We're good.
return
-
instance = self.make_instance()
self.instance = instance
super(TenantWithContainer, self).save()
@@ -193,7 +148,6 @@
(a, b, c, d) = ip.split('.')
return "02:42:%02x:%02x:%02x:%02x" % (int(a), int(b), int(c), int(d))
-
@property
def image(self):
img = self.image_name.strip()
@@ -202,60 +156,24 @@
else:
return super(VPGWCTenant, self).image
- # Getter for the message that will appear on the webpage
- # By default it is "Hello World!"
- @property
- def display_message(self):
- return self.get_attribute(
- "display_message",
- self.default_attributes['display_message'])
-
- @display_message.setter
- def display_message(self, value):
- self.set_attribute("display_message", value)
-
- @property
- def image_name(self):
- return self.get_attribute(
- "image_name",
- self.default_attributes['image_name'])
-
- @image_name.setter
- def image_name(self, value):
- self.set_attribute("image_name", value)
-
- @property
- def s5s8_pgw_tag(self):
- return self.get_attribute(
- "s5s8_pgw_tag",
- self.default_attributes['s5s8_pgw_tag'])
-
- @s5s8_pgw_tag.setter
- def s5s8_pgw_tag(self, value):
- self.set_attribute("s5s8_pgw_tag", value)
-
-
@property
def addresses(self):
if (not self.id) or (not self.instance):
return {}
-
addresses = {}
for ns in self.instance.ports.all():
if "s5s8_pgw" in ns.network.name.lower():
addresses["s5s8_pgw"] = (ns.ip, ns.mac)
return addresses
-
@property
def s5s8_pgw_ip(self):
return self.addresses.get("s5s8_pgw", (None, None))[0]
+
@property
def s5s8_pgw_mac(self):
return self.addresses.get("s5s8_pgw", (None, None))[1]
-
-
def model_policy_mcord_servicecomponent(pk):
# This section of code is atomic to prevent race conditions
with transaction.atomic():
diff --git a/xos/synchronizer/Dockerfile.synchronizer b/xos/synchronizer/Dockerfile.synchronizer
new file mode 100644
index 0000000..be0b17d
--- /dev/null
+++ b/xos/synchronizer/Dockerfile.synchronizer
@@ -0,0 +1,40 @@
+# xosproject/vpgwc-synchronizer
+
+FROM xosproject/xos-synchronizer-base:candidate
+
+COPY . /opt/xos/synchronizers/vpgwc
+
+ENTRYPOINT []
+
+WORKDIR "/opt/xos/synchronizers/vpgwc"
+
+# Label image
+ARG org_label_schema_schema_version=1.0
+ARG org_label_schema_name=vpgwc-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/vpgwc; ./run-from-api.sh"
\ No newline at end of file
diff --git a/xos/synchronizer/__init__.py b/xos/synchronizer/__init__.py
deleted file mode 100755
index e69de29..0000000
--- a/xos/synchronizer/__init__.py
+++ /dev/null
diff --git a/xos/synchronizer/manifest b/xos/synchronizer/manifest
deleted file mode 100644
index dc78252..0000000
--- a/xos/synchronizer/manifest
+++ /dev/null
@@ -1,9 +0,0 @@
-__init__.py
-manifest
-model-deps
-run.sh
-steps/sync_vpgwc.py
-steps/sync_vpgwc.yaml
-stop.sh
-vpgwc-synchronizer.py
-vpgwc_config
diff --git a/xos/synchronizer/run-from-api.sh b/xos/synchronizer/run-from-api.sh
new file mode 100755
index 0000000..db371d5
--- /dev/null
+++ b/xos/synchronizer/run-from-api.sh
@@ -0,0 +1 @@
+python vpgwc-synchronizer.py
diff --git a/xos/synchronizer/run.sh b/xos/synchronizer/run.sh
deleted file mode 100755
index 821e149..0000000
--- a/xos/synchronizer/run.sh
+++ /dev/null
@@ -1,3 +0,0 @@
-# Runs the XOS observer using helloworldservice_config
-export XOS_DIR=/opt/xos
-python vpgwc-synchronizer.py -C $XOS_DIR/synchronizers/vpgwc/vpgwc_config
diff --git a/xos/synchronizer/stop.sh b/xos/synchronizer/stop.sh
deleted file mode 100755
index 299641a..0000000
--- a/xos/synchronizer/stop.sh
+++ /dev/null
@@ -1,2 +0,0 @@
-# Kill the observer
-pkill -9 -f vpgwc-synchronizer.py
diff --git a/xos/synchronizer/vpgwc-synchronizer.py b/xos/synchronizer/vpgwc-synchronizer.py
index 95f4081..361ad7f 100755
--- a/xos/synchronizer/vpgwc-synchronizer.py
+++ b/xos/synchronizer/vpgwc-synchronizer.py
@@ -1,13 +1,17 @@
#!/usr/bin/env python
-# This imports and runs ../../xos-observer.py
-# Runs the standard XOS observer
+# Runs the standard XOS synchronizer
import importlib
import os
import sys
-observer_path = os.path.join(os.path.dirname(
- os.path.realpath(__file__)), "../../synchronizers/base")
-sys.path.append(observer_path)
+from xosconfig import Config
+
+config_file = os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/vpgwc_config.yaml')
+Config.init(config_file, 'synchronizer-config-schema.yaml')
+
+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()
+mod.main()
\ No newline at end of file
diff --git a/xos/synchronizer/vpgwc_config b/xos/synchronizer/vpgwc_config
deleted file mode 100755
index 7e00dd8..0000000
--- a/xos/synchronizer/vpgwc_config
+++ /dev/null
@@ -1,41 +0,0 @@
-# Required by XOS
-[db]
-name=xos
-user=postgres
-password=password
-host=xos_db
-port=5432
-
-# Required by XOS
-[api]
-nova_enabled=True
-
-
-# Sets options for the synchronizer
-[observer]
-# Optional name
-name=vpgwc
-# This is the location to the dependency graph you generate
-dependency_graph=/opt/xos/synchronizers/vpgwc/model-deps
-# The location of your SyncSteps
-steps_dir=/opt/xos/synchronizers/vpgwc/steps
-# A temporary directory that will be used by ansible
-sys_dir=/opt/xos/synchronizers/vpgwc/sys
-# Location of the file to save logging messages to the backend log is often used
-logfile=/var/log/xos_backend.log
-# If this option is true, then nothing will change, we simply pretend to run
-pretend=False
-# If this is False then XOS will use an exponential backoff when the observer
-# fails, since we will be waiting for an instance, we don't want this.
-backoff_disabled=True
-# We want the output from ansible to be logged
-save_ansible_output=True
-# This determines how we SSH to a client, if this is set to True then we try
-# to ssh using the instance name as a proxy, if this is disabled we ssh using
-# the NAT IP of the instance. On CloudLab the first option will fail so we must
-# set this to False
-proxy_ssh=True
-proxy_ssh_key=/root/setup/id_rsa
-proxy_ssh_user=root
-[networking]
-use_vtn=True
diff --git a/xos/synchronizer/vpgwc_config.yaml b/xos/synchronizer/vpgwc_config.yaml
new file mode 100755
index 0000000..0d6e5d1
--- /dev/null
+++ b/xos/synchronizer/vpgwc_config.yaml
@@ -0,0 +1,13 @@
+name: vpgwc-synchronizer
+accessor:
+ username: xosadmin@opencord.org
+ password: "@/opt/xos/services/vpgwc/credentials/xosadmin@opencord.org"
+required_models:
+ - VPGWCService
+ - VPGWCTenant
+ - ServiceDependency
+ - ServiceMonitoringAgentInfo
+dependency_graph: "/opt/xos/synchronizers/vpgwc/model-deps"
+steps_dir: "/opt/xos/synchronizers/vpgwc/steps"
+sys_dir: "/opt/xos/synchronizers/vpgwc/sys"
+model_policies_dir: "/opt/xos/synchronizers/vpgwc/model_policies"
\ No newline at end of file
diff --git a/xos/templates/vPGWCAdmin.html b/xos/templates/vPGWCAdmin.html
deleted file mode 100644
index 4585199..0000000
--- a/xos/templates/vPGWCAdmin.html
+++ /dev/null
@@ -1,10 +0,0 @@
-<!-- Template used to for the button leading to the HelloWorldTenantComplete form. -->
-<div class = "left-nav">
- <ul>
- <li>
- <a href="/admin/mcordservice/vpgwccomponent/">
- vPGWC Service Components
- </a>
- </li>
- </ul>
-</div>
diff --git a/xos/tosca/resources/VPGWCService.py b/xos/tosca/resources/VPGWCService.py
index 8123404..f87a1c6 100644
--- a/xos/tosca/resources/VPGWCService.py
+++ b/xos/tosca/resources/VPGWCService.py
@@ -1,10 +1,7 @@
-from services.vpgwc.models import VPGWCService
from service import XOSService
+from services.vpgwc.models import VPGWCService
class XOSVPGWCService(XOSService):
provides = "tosca.nodes.VPGWCService"
xos_model = VPGWCService
- copyin_props = ["view_url", "icon_url", "enabled", "published", "public_key",
- "private_key_fn", "versionNumber",
- ]
-
+ 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/VPGWCTenant.py b/xos/tosca/resources/VPGWCTenant.py
index 434972a..9b47e3b 100644
--- a/xos/tosca/resources/VPGWCTenant.py
+++ b/xos/tosca/resources/VPGWCTenant.py
@@ -1,18 +1,20 @@
-from services.vpgwc.models import VPGWCTenant, VPGWCService
from xosresource import XOSResource
+from core.models import Tenant, Service
+from services.vpgwc.models import VPGWCTenant
class XOSVPGWCTenant(XOSResource):
provides = "tosca.nodes.VPGWCTenant"
xos_model = VPGWCTenant
- copyin_props = ["s5s8_pgw_tag", "display_message", "image_name"]
name_field = None
+ copyin_props = ["s5s8_pgw_tag", "display_message", "image_name"]
def get_xos_args(self, throw_exception=True):
args = super(XOSVPGWCTenant, self).get_xos_args()
- provider_name = self.get_requirement("tosca.relationships.MemberOfService", throw_exception=throw_exception)
+ # 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(VPGWCService, throw_exception=throw_exception, name=provider_name)
+ args["provider_service"] = self.get_xos_object(Service, throw_exception=True, name=provider_name)
return args
@@ -20,7 +22,7 @@
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 [self.get_xos_object(provider_service=provider_service)]
return []
def postprocess(self, obj):
@@ -28,4 +30,3 @@
def can_delete(self, obj):
return super(XOSVPGWCTenant, self).can_delete(obj)
-
diff --git a/xos/vPGWC-onboard.yaml b/xos/vPGWC-onboard.yaml
deleted file mode 100644
index 555d3f1..0000000
--- a/xos/vPGWC-onboard.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-tosca_definitions_version: tosca_simple_yaml_1_0
-
-description: Onboard the vPGWC service
-
-imports:
- - custom_types/xos.yaml
-
-topology_template:
- node_templates:
- servicecontroller#vpgwc:
- type: tosca.nodes.ServiceController
- properties:
- base_url: file:///opt/xos_services/vPGWC/xos/
- # The following will concatenate with base_url automatically, if
- # base_url is non-null.
- models: models.py
- admin: admin.py
- admin_template: templates/vPGWCAdmin.html
- synchronizer: synchronizer/manifest
- synchronizer_run: vpgwc-synchronizer.py
- #tosca_custom_types: exampleservice.yaml
- tosca_resource: tosca/resources/VPGWCTenant.py, tosca/resources/VPGWCService.py
- #rest_service: subdirectory:vsg api/service/vsg/vsgservice.py
- #rest_tenant: subdirectory:cord api/tenant/cord/vsg.py
- private_key: file:///opt/xos/key_import/vPGWC_rsa
- public_key: file:///opt/xos/key_import/vPGWC_rsa.pub
diff --git a/xos/vpgwc-onboard.yaml b/xos/vpgwc-onboard.yaml
new file mode 100644
index 0000000..a287d35
--- /dev/null
+++ b/xos/vpgwc-onboard.yaml
@@ -0,0 +1,22 @@
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+description: Onboard the exampleservice
+
+imports:
+ - custom_types/xos.yaml
+
+topology_template:
+ node_templates:
+ vpgwc:
+ type: tosca.nodes.ServiceController
+ properties:
+ base_url: file:///opt/xos_services/vpgwc/xos/
+ # The following will concatenate with base_url automatically, if
+ # base_url is non-null.
+ xproto: ./
+ admin: admin.py
+ tosca_custom_types: vpgwc.yaml
+ tosca_resource: tosca/resources/vpgwcservice.py, tosca/resources/vpgwctenant.py
+ private_key: file:///opt/xos/key_import/mcord_rsa
+ public_key: file:///opt/xos/key_import/mcord_rsa.pub
+
diff --git a/xos/vpgwc.m4 b/xos/vpgwc.m4
new file mode 100644
index 0000000..7ee6fb0
--- /dev/null
+++ b/xos/vpgwc.m4
@@ -0,0 +1,54 @@
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+# compile this with "m4 vpgwc.m4 > vpgwc.yaml"
+
+# include macros
+include(macros.m4)
+
+node_types:
+ tosca.nodes.VPGWCService:
+ derived_from: tosca.nodes.Root
+ description: >
+ CORD: The vPGWC Service
+ capabilities:
+ xos_base_service_caps
+ properties:
+ xos_base_props
+ xos_base_service_props
+ view_url:
+ type: string
+ required: false
+ icon_url:
+ type: string
+ required: false
+ enabled:
+ type: boolean
+ required: true
+ published:
+ type: boolean
+ required: true
+ public_key:
+ type: string
+ required: false
+ private_key_fn:
+ type: string
+ required: false
+ versionNumber:
+ type: string
+ required: false
+
+ tosca.nodes.VPGWCTenant:
+ derived_from: tosca.nodes.Root
+ description: >
+ CORD: The vPGWC 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
\ No newline at end of file
diff --git a/xos/vpgwc.xproto b/xos/vpgwc.xproto
new file mode 100644
index 0000000..4ae865c
--- /dev/null
+++ b/xos/vpgwc.xproto
@@ -0,0 +1,16 @@
+option name = "vPGWC";
+option verbose_name = "VPGWCService";
+option legacy = "True";
+
+message VPGWCService (Service) {
+ option name = "VPGWCService";
+ option verbose_name = "Virtual Packet Gateway Control Service";
+}
+
+message VPGWCTenant (TenantWithContainer) {
+ option name = "VPGWCTenant";
+ option verbose_name = "Virtual Packet Gateway Control Tenant";
+ optional string display_message = 1 [db_index = False, max_length = 1024, null = True, blank = False, default = "New vpgwc 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"];
+}
diff --git a/xos/vpgwc.yaml b/xos/vpgwc.yaml
new file mode 100644
index 0000000..23e8636
--- /dev/null
+++ b/xos/vpgwc.yaml
@@ -0,0 +1,124 @@
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+# compile this with "m4 vpgwc.m4 > vpgwc.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.VPGWCService:
+ derived_from: tosca.nodes.Root
+ description: >
+ CORD: The vPGWC 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.
+ view_url:
+ type: string
+ required: false
+ icon_url:
+ type: string
+ required: false
+ enabled:
+ type: boolean
+ required: true
+ published:
+ type: boolean
+ required: true
+ public_key:
+ type: string
+ required: false
+ private_key_fn:
+ type: string
+ required: false
+ versionNumber:
+ type: string
+ required: false
+
+ tosca.nodes.VPGWCTenant:
+ derived_from: tosca.nodes.Root
+ description: >
+ CORD: The vPGWC 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
\ No newline at end of file