Merge branch 'beierlm-ns-primitives' into 'master' (5ab76ff6) · Commits · vnf-onboarding / OSM Packages

nscharm_ns/charms/ns/.build.manifest

0 → 100644

+277 −0

Original line number	Diff line number	Diff line
		{
		"layers": [
		{
		"rev": "fcdcea4e5de3e1556c24e6704607862d0ba00a56",
		"url": "layer:options"
		},
		{
		"rev": "1d2489bff56daf2f8d1c06ee9248bb0094e4ad49",
		"url": "layer:basic"
		},
		{
		"rev": "4f3159205af1b3e7a3a532dedcf6b887d2e6d78a",
		"url": "layer:osm-ns"
		},
		{
		"rev": "aa34ff8bbe4d847102174d9038068af0f6ebe575",
		"url": "ns"
		}
		],
		"signatures": {
		".build.manifest": [
		"build",
		"dynamic",
		"unchecked"
		],
		".gitignore": [
		"layer:basic",
		"static",
		"0da5c4dcda27cd6406e5bb81cbf68ddccaf728ac764ec15053a165c1449d87d9"
		],
		"LICENSE": [
		"layer:basic",
		"static",
		"cfc7749b96f63bd31c3c42b5c471bf756814053e847c10f3eb003417bc523d30"
		],
		"Makefile": [
		"layer:basic",
		"static",
		"b7ab3a34e5faf79b96a8632039a0ad0aa87f2a9b5f0ba604e007cafb22190301"
		],
		"README.md": [
		"ns",
		"static",
		"2d66b85187cdce4854d3a5a39f7458faf882b919b47a83a675654cdcaa520742"
		],
		"actions.yaml": [
		"ns",
		"dynamic",
		"d3eeb0c4a2386661202166c19774b6ae9e04ae71dda52a027bffdf67075a1448"
		],
		"actions/add-user": [
		"ns",
		"static",
		"46bf4be02078a0f5ac60ab81609372a8f9943885b7a4999ce5332ea2f4857036"
		],
		"bin/charm-env": [
		"layer:basic",
		"static",
		"458c53532c19ee357cbf4209ccc7d811810718ba0ea3b0588b3d3ef040a44b8e"
		],
		"bin/layer_option": [
		"layer:options",
		"static",
		"e959bf29da4c5edff28b2602c24113c4df9e25cdc9f2aa3b5d46c8577b2a40cc"
		],
		"config.yaml": [
		"ns",
		"dynamic",
		"ae697230ea4c0e9ac8ec8fa039dbb11304cad42011adcaa40a8412c47159324b"
		],
		"copyright": [
		"layer:basic",
		"static",
		"f6740d66fd60b60f2533d9fcb53907078d1e20920a0219afce7182e2a1c97629"
		],
		"copyright.layer-options": [
		"layer:options",
		"static",
		"f6740d66fd60b60f2533d9fcb53907078d1e20920a0219afce7182e2a1c97629"
		],
		"hooks/config-changed": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/hook.template": [
		"layer:basic",
		"static",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/install": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/leader-elected": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/leader-settings-changed": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/post-series-upgrade": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/pre-series-upgrade": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/start": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/stop": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/update-status": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"hooks/upgrade-charm": [
		"layer:basic",
		"dynamic",
		"2b693cb2a11594a80cc91235c2dc219a0a6303ae62bee8aa87eb35781f7158f7"
		],
		"icon.svg": [
		"ns",
		"static",
		"d20624e9389af6506a8d8a69ac9bba4d41709601b624c0875fd7d6717b395088"
		],
		"layer.yaml": [
		"ns",
		"dynamic",
		"6e5423e1b33993267456ad163ecf0fcd9e921f99214fbc6f23a1d7902468df8f"
		],
		"lib/charms/layer/__init__.py": [
		"layer:basic",
		"static",
		"dfe0d26c6bf409767de6e2546bc648f150e1b396243619bad3aa0553ab7e0e6f"
		],
		"lib/charms/layer/basic.py": [
		"layer:basic",
		"static",
		"445652dbaa1f0b84a7215da185bcbdff097bb9bbbce11b4c2dbbff90f77719a9"
		],
		"lib/charms/layer/execd.py": [
		"layer:basic",
		"static",
		"fda8bd491032db1db8ddaf4e99e7cc878c6fb5432efe1f91cadb5b34765d076d"
		],
		"lib/charms/layer/options.py": [
		"layer:options",
		"static",
		"8ae7a07d22542fc964f2d2bee8219d1c78a68dace70a1b38d36d4aea47b1c3b2"
		],
		"lib/charms/osm/ns.py": [
		"layer:osm-ns",
		"static",
		"743c4d49f0bd5a143057a0370fc47a837e0ee43d8eceff8e90b7f05e4db7b1e9"
		],
		"metadata.yaml": [
		"ns",
		"dynamic",
		"19db902355c43e4f6c41291e48c7a1d1c789a13774a49b524d1d052dbbacc32f"
		],
		"reactive/__init__.py": [
		"layer:basic",
		"static",
		"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
		],
		"reactive/ns.py": [
		"ns",
		"static",
		"1d1c34c9cdb049552d0c79219cade41e70ae4d76782a305be0e8d4d6928afeb4"
		],
		"reactive/osm_ns.py": [
		"layer:osm-ns",
		"static",
		"d29161a94d60dc8666ede44e4bfe7f51fe052f919eb9c03db03b2111a8f2b68c"
		],
		"requirements.txt": [
		"layer:basic",
		"static",
		"0f1c70d27e26005a96d66ad54482877ae20f7737693c833e29dd72bd6ac24892"
		],
		"tests/00-setup": [
		"ns",
		"static",
		"111c079b81d260bbcd716dcf41672372a4cf4aaa14154b6c3055deeedae37a06"
		],
		"tests/10-deploy": [
		"ns",
		"static",
		"1750031833a1d3e3dfa1e7f5ee97f75cb84ac2e483b1470b2b41e17f0b39c173"
		],
		"version": [
		"ns",
		"dynamic",
		"260a9a4811db0cebf6acd4bb4910f460278b8c449d7437a7c908ce864fc6a184"
		],
		"wheelhouse/Jinja2-2.10.3.tar.gz": [
		"layer:basic",
		"dynamic",
		"9fe95f19286cfefaa917656583d020be14e7859c6b0252588391e47db34527de"
		],
		"wheelhouse/MarkupSafe-1.1.1.tar.gz": [
		"layer:basic",
		"dynamic",
		"29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b"
		],
		"wheelhouse/PyYAML-5.2.tar.gz": [
		"layer:basic",
		"dynamic",
		"c0ee8eca2c582d29c3c2ec6e2c4f703d1b7f1fb10bc72317355a746057e7346c"
		],
		"wheelhouse/Tempita-0.5.2.tar.gz": [
		"layer:basic",
		"dynamic",
		"cacecf0baa674d356641f1d406b8bff1d756d739c46b869a54de515d08e6fc9c"
		],
		"wheelhouse/charmhelpers-0.20.7.tar.gz": [
		"layer:basic",
		"dynamic",
		"e0f8d005d39cded1b0c5997d8ef1d90832341c67ebeb4a334ad1eb348fbd803a"
		],
		"wheelhouse/charms.reactive-1.3.0.tar.gz": [
		"layer:basic",
		"dynamic",
		"82d2c614c82d64bf56e913990f22663e5de64b99db15838abfd9a064f1cc2f51"
		],
		"wheelhouse/netaddr-0.7.19.tar.gz": [
		"layer:basic",
		"dynamic",
		"38aeec7cdd035081d3a4c306394b19d677623bf76fa0913f6695127c7753aefd"
		],
		"wheelhouse/pip-18.1.tar.gz": [
		"layer:basic",
		"dynamic",
		"c0a292bd977ef590379a3f05d7b7f65135487b67470f6281289a94e015650ea1"
		],
		"wheelhouse/pyaml-19.12.0.tar.gz": [
		"layer:basic",
		"dynamic",
		"b3f636b467864319d7ded1558f86bb305b8612a274f5d443a62dc5eceb1b7176"
		],
		"wheelhouse/setuptools-41.6.0.zip": [
		"layer:basic",
		"dynamic",
		"6afa61b391dcd16cb8890ec9f66cc4015a8a31a6e1c2b4e0c464514be1a3d722"
		],
		"wheelhouse/setuptools_scm-1.17.0.tar.gz": [
		"layer:basic",
		"dynamic",
		"70a4cf5584e966ae92f54a764e6437af992ba42ac4bca7eb37cc5d02b98ec40a"
		],
		"wheelhouse/six-1.13.0.tar.gz": [
		"layer:basic",
		"dynamic",
		"30f610279e8b2578cab6db20741130331735c781b56053c59c4076da27f06b66"
		],
		"wheelhouse/wheel-0.33.6.tar.gz": [
		"layer:basic",
		"dynamic",
		"10c9da68765315ed98850f8e048347c3eb06dd81822dc2ab1d4fde9dc9702646"
		]
		}
		}
		No newline at end of file

nscharm_ns/charms/ns/.gitignore

0 → 100644

+5 −0

Original line number	Diff line number	Diff line
		*.pyc
		*~
		.ropeproject
		.settings
		.tox

nscharm_ns/charms/ns/LICENSE

0 → 100644

+202 −0

Original line number	Diff line number	Diff line

		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 [yyyy] [name of copyright owner]

		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.

nscharm_ns/charms/ns/Makefile

0 → 100644

+24 −0

Original line number	Diff line number	Diff line
		#!/usr/bin/make

		all: lint unit_test


		.PHONY: clean
		clean:
		@rm -rf .tox

		.PHONY: apt_prereqs
		apt_prereqs:
		@# Need tox, but don't install the apt version unless we have to (don't want to conflict with pip)
		@which tox >/dev/null \|\| (sudo apt-get install -y python-pip && sudo pip install tox)

		.PHONY: lint
		lint: apt_prereqs
		@tox --notest
		@PATH=.tox/py34/bin:.tox/py35/bin flake8 $(wildcard hooks reactive lib unit_tests tests)
		@charm proof

		.PHONY: unit_test
		unit_test: apt_prereqs
		@echo Starting tests...
		tox

nscharm_ns/charms/ns/README.md

0 → 100644

+117 −0

Original line number	Diff line number	Diff line
		# Overview

		This is an example of an Open Source Mano (OSM) Network Service (ns) charm. This is an experimental feature, expected to be released with OSM R6 in the spring of 2019.

		This allows a charm to coordinate the execution of [actions] across multiple charms within a model.

		# Usage

		# Application Names

		Each deployed application is named using a set of runtime variables, such as the network service name, the vnf or vdu name, and the vnf-member-index. Because of that, we'll need to provide those values to the NS charm through its configuration.

		# Configuration

		The `config.yaml` file contains a mapping of properties that will be passed from OSM to your deployed charm. Some of those properties are automatically included by the underlying `osm-ns` layer:
		- juju-username
		- juju-password

		You'll need to pass the name of the network service that you deployed. Even though your network service may be named `nscharm` in the descriptor, the operator provides a name at instantiation time, and `osm-ns` needs this name in order to resolve the application names. You can call it anything you like, as long as it's consistent between the NS charm and the NS Descriptor.

		For each VNF or VDU with a charm you wish to interact with, you need to also pass it's id from the VNF Descriptor. Again, you can call this anything you like, as long as it's consistent between the NS charm and NS Descriptor.

		`config.yaml`:
		```yaml
		options:
		nsr-name:
		default:
		description: The runtime name of the Network Service, i.e., what its deployed name is.
		type: string

		user-member-index:
		default:
		description: The vnf-member-index of the user VNF.
		type: string
		user-vdu-id:
		default:
		description: The id of the VDU containing the charm.
		type: string

		policy-member-index:
		default:
		description: The vnf-member-index of the policy VNF.
		type: string
		policy-vdu-id:
		default:
		description: The id of the VDU containing the charm.
		type: string
		```

		# NS Descriptor

		The NS descriptor contains a new `ns-configuration` element, similar to that of `vnf-configuration` and `vdu-configuration` available in VNF descriptors.

		The key here is to pass the juju credentials from your environment, available in `~/.local/share/juju/accounts.yaml`. This enables the charm to speak directly to Juju, via the `osm-ns` layer.

		Next, you must map the runtime parameters of your Network Service so that the charm is aware of your topology.

		Lastly, you can then define the primitives, under `config-primitive`, to be available to the operator for day-2 operation.

		```yaml
		ns-configuration:
		juju:
		charm: ns
		initial-config-primitive:
		- seq: '1'
		name: config
		parameter:
		# Configure Juju credentials
		- name: juju-username
		value: 'admin'
		- name: juju-password
		value: '50b4491a7a42d3542e317e3ae94c6c96'

		# Set the runtime name of the network service
		- name: nsr-name
		value: 'test'

		# For each vnf, map the vnf-member-index and vdu-id
		- name: user-member-index
		value: '1'
		- name: user-vdu-id
		value: 'userVM'

		- name: policy-member-index
		value: '2'
		- name: policy-vdu-id
		value: 'policyVM'

		- seq: '2'
		name: add-user
		parameter:
		- name: username
		value: root
		config-primitive:
		- name: add-user
		parameter:
		- name: username
		data-type: STRING
		```

		## Known Limitations and Issues

		This functionality is EXPERIMENTAL.

		# Configuration

		# Contact Information


		## Open Source Mano (OSM)

		- [OSM website](https://osm.etsi.org/)
		- [OSM bug tracker](https://osm.etsi.org/bugzilla/)
		- [OSM_TECH](mailto:OSM_TECH@list.etsi.org) mailing list
		- [Slack](https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWJkMzRjNDM0MjFjODYzMGQ3ODIzMzJlNTg2ZGI5OTdiZjFiNDMyMzYxMjRjNDU4N2FmNjRjNzY5NTE1MjgzOTQ)

		[actions]: https://docs.jujucharms.com/2.5/en/actions