diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/actions.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/actions.yaml new file mode 100644 index 0000000000000000000000000000000000000000..f9882c47bba960254e0381e5b5ab1c0688de6cf5 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/actions.yaml @@ -0,0 +1,54 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# 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. +## +touch: + description: "Touch a file on the VNF." + params: + filename: + description: "The name of the file to touch." + type: string + default: "" + required: + - filename + +# Standard OSM functions +start: + description: "Stop the service on the VNF." +stop: + description: "Stop the service on the VNF." +restart: + description: "Stop the service on the VNF." +reboot: + description: "Reboot the VNF virtual machine." +upgrade: + description: "Upgrade the software on the VNF." + +# Required by charms.osm.sshproxy +run: + description: "Run an arbitrary command" + params: + command: + description: "The command to execute." + type: string + default: "" + required: + - command +generate-ssh-key: + description: "Generate a new SSH keypair for this unit. This will replace any existing previously generated keypair." +verify-ssh-credentials: + description: "Verify that this unit can authenticate with server specified by ssh-hostname and ssh-username." +get-ssh-public-key: + description: "Get the public SSH key for this unit." diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/config.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..93e3cab01c0843418c57e4bc918eb933f2daf934 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/config.yaml @@ -0,0 +1,41 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# 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. +## +options: + ssh-hostname: + type: string + default: "" + description: "The hostname or IP address of the machine to" + ssh-username: + type: string + default: "" + description: "The username to login as." + ssh-password: + type: string + default: "" + description: "The password used to authenticate." + ssh-public-key: + type: string + default: "" + description: "The public key of this unit." + ssh-key-type: + type: string + default: "rsa" + description: "The type of encryption to use for the SSH key." + ssh-key-bits: + type: int + default: 4096 + description: "The number of bits to use for the SSH key." diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/install b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/install new file mode 100755 index 0000000000000000000000000000000000000000..e23b12b7bcfddfd49d4efbc1b0ac72d92579778a --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/install @@ -0,0 +1,65 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys + +sys.path.append("lib") + +from charms.osm.sshproxy import SSHProxyCharm +from ops.main import main + +class MySSHProxyCharm(SSHProxyCharm): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + """Called when the charm is being installed""" + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being started""" + super().on_start(event) + + def on_touch_action(self, event): + """Touch a file.""" + + if self.model.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + +if __name__ == "__main__": + main(MySSHProxyCharm) + diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/start b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/start new file mode 100755 index 0000000000000000000000000000000000000000..e23b12b7bcfddfd49d4efbc1b0ac72d92579778a --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/start @@ -0,0 +1,65 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys + +sys.path.append("lib") + +from charms.osm.sshproxy import SSHProxyCharm +from ops.main import main + +class MySSHProxyCharm(SSHProxyCharm): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + """Called when the charm is being installed""" + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being started""" + super().on_start(event) + + def on_touch_action(self, event): + """Touch a file.""" + + if self.model.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + +if __name__ == "__main__": + main(MySSHProxyCharm) + diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/upgrade-charm b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/upgrade-charm new file mode 100755 index 0000000000000000000000000000000000000000..e23b12b7bcfddfd49d4efbc1b0ac72d92579778a --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/upgrade-charm @@ -0,0 +1,65 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys + +sys.path.append("lib") + +from charms.osm.sshproxy import SSHProxyCharm +from ops.main import main + +class MySSHProxyCharm(SSHProxyCharm): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + """Called when the charm is being installed""" + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being started""" + super().on_start(event) + + def on_touch_action(self, event): + """Touch a file.""" + + if self.model.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + +if __name__ == "__main__": + main(MySSHProxyCharm) + diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/lib/charms b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/lib/charms new file mode 120000 index 0000000000000000000000000000000000000000..5abf77aa5a04fddc6d4eb9d0d6d17e36fd00272a --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/lib/charms @@ -0,0 +1 @@ +../mod/charms.osm/charms/ \ No newline at end of file diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/lib/ops b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/lib/ops new file mode 120000 index 0000000000000000000000000000000000000000..c36dab1ed4a93aee97a31b0eba0438852c5e05bf --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/lib/ops @@ -0,0 +1 @@ +../mod/operator/ops/ \ No newline at end of file diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/metadata.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/metadata.yaml new file mode 100644 index 0000000000000000000000000000000000000000..76b268bfca697808056fb7386913e592df4b508d --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/metadata.yaml @@ -0,0 +1,30 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +name: simple-ha-proxy +summary: A simple example proxy charm +description: | + Simple proxy charm is an example charm used in OSM Hackfests +series: + - xenial + - bionic +peers: + proxypeer: + interface: proxypeer +provides: + interface: + interface: interface \ No newline at end of file diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/src/charm.py b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/src/charm.py new file mode 100755 index 0000000000000000000000000000000000000000..1092fc34023c21e26eeb7f5cb81876c9d5b21c44 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/src/charm.py @@ -0,0 +1,73 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys + +sys.path.append("lib") + +from charms.osm.sshproxy import SSHProxyCharm +from ops.main import main + +class MySSHProxyCharm(SSHProxyCharm): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + self.framework.observe( + self.on.interface_relation_changed, self.on_interface_relation_changed + ) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + """Called when the charm is being installed""" + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being started""" + super().on_start(event) + + def on_touch_action(self, event): + """Touch a file.""" + + if self.model.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + + def on_interface_relation_changed(self, event): + parameter = "Hello" + event.relation.data[self.model.unit]["parameter"] = parameter + self.model.unit.status = ActiveStatus("Parameter sent: {}".format(parameter)) + + +if __name__ == "__main__": + main(MySSHProxyCharm) diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/actions.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/actions.yaml new file mode 100644 index 0000000000000000000000000000000000000000..53a706b4eba7347764c4711b7077146e72241de4 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/actions.yaml @@ -0,0 +1,25 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# 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. +## +touch: + description: "Touch a file on the VNF." + params: + filename: + description: "The name of the file to touch." + type: string + default: "" + required: + - filename diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/charmcraft.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/charmcraft.yaml new file mode 100644 index 0000000000000000000000000000000000000000..98f146b8dad5207ca673a7d6d2f5e570d03e0113 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/charmcraft.yaml @@ -0,0 +1,34 @@ +# Copyright 2021 Canonical Ltd. +# +# 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. +# +# For those usages not covered by the Apache License, Version 2.0 please +# contact: legal@canonical.com +# +# To get in touch with the maintainers, please contact: +# osm-charmers@lists.launchpad.net +## + +type: charm +bases: + - build-on: + - name: ubuntu + channel: "20.04" + architectures: ["amd64"] + run-on: + - name: ubuntu + channel: "20.04" + architectures: [amd64] +parts: + charm: + build-packages: [git] diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/config.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..2be62318c6ce27156e4af585494b36d0c2b802f8 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/config.yaml @@ -0,0 +1,17 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# 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. +## +options: {} \ No newline at end of file diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/metadata.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/metadata.yaml new file mode 100644 index 0000000000000000000000000000000000000000..071f8fa8d2b605f85a78f2322ba8c096c65e1326 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/metadata.yaml @@ -0,0 +1,28 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +name: simple-native-requires +summary: A simple native charm +description: | + Simple native charm +series: + - bionic + - xenial + - focal +requires: + interface: + interface: interface \ No newline at end of file diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/requirements.txt b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..95534d009733936b25808078f8f70b14b92da644 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/requirements.txt @@ -0,0 +1 @@ +ops \ No newline at end of file diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/src/charm.py b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/src/charm.py new file mode 100755 index 0000000000000000000000000000000000000000..c243dc90a31ba2fb5c14143a5d658f7b8dfd2dcc --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/src/charm.py @@ -0,0 +1,80 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys +import subprocess +import logging + +sys.path.append("lib") + +from ops.charm import CharmBase +from ops.main import main +from ops.model import ActiveStatus + +logger = logging.getLogger(__name__) + +class MyNativeCharm(CharmBase): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + + # Listen to relation changed + self.framework.observe( + self.on.interface_relation_changed, self.on_interface_relation_changed + ) + def on_config_changed(self, event): + """Handle changes in configuration""" + self.model.unit.status = ActiveStatus() + + def on_install(self, event): + """Called when the charm is being installed""" + self.model.unit.status = ActiveStatus() + + def on_start(self, event): + """Called when the charm is being started""" + self.model.unit.status = ActiveStatus() + + def on_touch_action(self, event): + """Touch a file.""" + + filename = event.params["filename"] + try: + subprocess.run(["touch", filename], check=True) + event.set_results({"created": True, "filename": filename}) + except subprocess.CalledProcessError as e: + event.fail("Action failed: {}".format(e)) + self.model.unit.status = ActiveStatus() + + def on_interface_relation_changed(self, event): + logger.debug("RELATION DATA: {}".format(dict(event.relation.data[event.unit]))) + parameter = event.relation.data[event.unit].get("parameter") + if parameter: + self.model.unit.status = ActiveStatus("Parameter received: {}".format(parameter)) + + +if __name__ == "__main__": + main(MyNativeCharm) + diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.flake8 b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.flake8 new file mode 100644 index 0000000000000000000000000000000000000000..8ef84fcd43f3b7a46768c31b20f36cab48ffdfe0 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.flake8 @@ -0,0 +1,9 @@ +[flake8] +max-line-length = 99 +select: E,W,F,C,N +exclude: + venv + .git + build + dist + *.egg_info diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.gitignore b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..948414822ae161179ba6afcfd7a2222afb8905c6 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.gitignore @@ -0,0 +1,10 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. + +__pycache__ +*.pyc +.vscode +venv +sshproxy.charm +build +__pycache__ \ No newline at end of file diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.jujuignore b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.jujuignore new file mode 100644 index 0000000000000000000000000000000000000000..6ccd559eabeae93e4d23215fa450130fa9b37ace --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.jujuignore @@ -0,0 +1,3 @@ +/venv +*.py[cod] +*.charm diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/LICENSE b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..94a9ed024d3859793618152ea559a168bbcbb5e2 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/README.md b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/README.md new file mode 100644 index 0000000000000000000000000000000000000000..06752f602017030685d07c650edb3e97486520e6 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/README.md @@ -0,0 +1,131 @@ +# sshproxy + +## Description + +SSHProxy Charm example for Open Source MANO. + +The purpose of this charm is to operate a VNF via SSH. For this, the charm should know the hostname of the VNF (ip address), and the username. The charm will be in a blocked state until it has the hostname, username, and the credentials for SSH-ing to the VNF. Both hostname and username are set via config, with `ssh-hostname` and `ssh-username` respectively. + +There are two ways of specifying the credentials: password, keys. (See next section) + + +## Usage + +This charm works for both LXD and K8s. By default, it will work on LXD. To make it work in K8s, just change the following in the `metadata.yaml` + +```yaml +series: +# - focal +# - bionic +# - xenial + - kubernetes + deployment: + mode: operator +``` + +### Prepare the environment: + +- LXD: + +```bash +sudo snap install juju --classic +juju bootstrap lxd +juju add-model test +``` + +- K8s: + +```bash +sudo snap install juju --classic +sudo snap install microk8s --classic +sudo microk8s.status --wait-ready +sudo microk8s.enable storage dns +juju bootstrap microk8s +juju add-model test +``` + +### Deploying charm: + +```bash +charmcraft build +juju deploy ./sshproxy.charm +``` + +### Configuring the charm: + +First of all, set the username and hostname of the VNF: + +```bash +juju config sshproxy ssh-hostname= \ + ssh-username= +``` + +#### Mirrors + +To workaround this [bug](https://bugs.launchpad.net/juju/+bug/1929399), use the following configurations of the charm to specify the urls of apt and security mirrors. + +```bash +juju config sshproxy apt-mirror= \ + security-apt-mirror= +``` + +### Credentials + +There are two ways to set up the credentials for the charm to be able to SSH the VNF. + +With password: + +```bash +juju config sshproxy ssh-password= +``` + +With public keys: + +1. First get the public key from the charm + +```bash +$ juju run-action sshproxy/0 get-ssh-public-key --wait +unit-sshproxy-0: + UnitId: sshproxy/0 + id: "12" + results: + pubkey: | + ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQC0IgSXMsu/5tY9QjsQfiAqcs6MBMO/7BDJB1ohbJFfvFrPiGg3+5FohKOsgu3SPiZbBhTITmI1YdaiZK7Dye2tHUfQKXhPFVFFVRtyWG6U/QJqEn+6OvAhjladcBlah4cb//r8V2Lvk/PshBJPzgvYSNJOhMhpfAMc7SMMpS8VxGBDIuTE0JFlHcRALJy3YBg70DPea2xrLsxqfA2pTA33KcjK2GyLgfOcZavmkqudEA/WaFb0xCY16TB/hDQBSwZm3l2kJ2aHyAWyWMmLNGL0TT14HUQKR1a8NS/kAnKY/yQf04dKoicmCvl4B3ndIYFT5Pq9b07mVfZvEH5Blle/x48iUF6JHWH2383SXwZfGy3XcX+lRx3u+IIkzS/Pmgt175JVdpu8bktk1c3Ekc0aL9v1gJ8rmZo+C6cilBoaziPfbqIatGPeGxnTDdw0JSfpxUGIQF4H98VOdWf3cHGC1hJZubZt0MGYeK4bk7GfsVPMlGaBWDyTaBQ5d9dHGxJpJX5OMBCDD4MfBYvg9IlgsVr1vDbpB4OFoAmQqFgnUWxRg2w0Iv3HBeMCvvOMM7DBOjwgjgbwa693Oyt/Rxd3GOwvy6vRQkFTgVS6f69SyIMCj9aIl1zxkIcOsfM5aU6vgio1BVWt9Xrj1TA3dTYJ7fkC5LJetqJ1knO67u67ww== root@juju-73fac6-2 + status: completed + timing: + completed: 2020-11-18 15:42:03 +0000 UTC + enqueued: 2020-11-18 15:42:00 +0000 UTC + started: 2020-11-18 15:42:03 +0000 UTC +``` +2. Inject that key in `~/.ssh/authorized_keys` at the VNF +3. Verify the ssh credentials + +```bash +$ juju run-action sshproxy/0 verify-ssh-credentials --wait +unit-sshproxy-0: + UnitId: sshproxy/0 + id: "14" + results: + verified: "True" + status: completed + timing: + completed: 2020-11-18 15:39:30 +0000 UTC + enqueued: 2020-11-18 15:39:29 +0000 UTC + started: 2020-11-18 15:39:29 +0000 UTC +``` + + +## Developing + +Create and activate a virtualenv with the development requirements: + + virtualenv -p python3 venv + source venv/bin/activate + pip install -r requirements-dev.txt + +## Testing + +The Python operator framework includes a very nice harness for testing +operator behaviour without full deployment. Just `run_tests`: + + ./run_tests diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/actions.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/actions.yaml new file mode 100644 index 0000000000000000000000000000000000000000..07987d2c26ec9b507818300b2f115464ca0d6830 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/actions.yaml @@ -0,0 +1,44 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. +# +# This is only an example, and you should edit to suit your needs. +# If you don't need actions, you can remove the file entirely. +# It ties in to the example _on_fortune_action handler in src/charm.py +touch: + description: "Touch a file on the VNF." + params: + filename: + description: "The name of the file to touch." + type: string + default: "" + required: + - filename + +# Standard OSM functions +start: + description: "Stop the service on the VNF." +stop: + description: "Stop the service on the VNF." +restart: + description: "Stop the service on the VNF." +reboot: + description: "Reboot the VNF virtual machine." +upgrade: + description: "Upgrade the software on the VNF." + +# Required by charms.osm.sshproxy +run: + description: "Run an arbitrary command" + params: + command: + description: "The command to execute." + type: string + default: "" + required: + - command +generate-ssh-key: + description: "Generate a new SSH keypair for this unit. This will replace any existing previously generated keypair." +verify-ssh-credentials: + description: "Verify that this unit can authenticate with server specified by ssh-hostname and ssh-username." +get-ssh-public-key: + description: "Get the public SSH key for this unit." diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/charmcraft.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/charmcraft.yaml new file mode 100644 index 0000000000000000000000000000000000000000..98f146b8dad5207ca673a7d6d2f5e570d03e0113 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/charmcraft.yaml @@ -0,0 +1,34 @@ +# Copyright 2021 Canonical Ltd. +# +# 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. +# +# For those usages not covered by the Apache License, Version 2.0 please +# contact: legal@canonical.com +# +# To get in touch with the maintainers, please contact: +# osm-charmers@lists.launchpad.net +## + +type: charm +bases: + - build-on: + - name: ubuntu + channel: "20.04" + architectures: ["amd64"] + run-on: + - name: ubuntu + channel: "20.04" + architectures: [amd64] +parts: + charm: + build-packages: [git] diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/config.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..adf2d8a11dfa13c7a75f6d934bf594ad06f911de --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/config.yaml @@ -0,0 +1,40 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. +# +# This is only an example, and you should edit to suit your needs. +# If you don't need config, you can remove the file entirely. +options: + ssh-hostname: + type: string + default: "" + description: "The hostname or IP address of the machine to" + ssh-username: + type: string + default: "" + description: "The username to login as." + ssh-password: + type: string + default: "" + description: "The password used to authenticate." + # ssh-private-key: + # type: string + # default: "" + # description: "DEPRECATED. The private ssh key to be used to authenticate." + ssh-public-key: + type: string + default: "" + description: "The public key of this unit." + ssh-key-type: + type: string + default: "rsa" + description: "The type of encryption to use for the SSH key." + ssh-key-bits: + type: int + default: 4096 + description: "The number of bits to use for the SSH key." + apt-mirror: + type: string + description: "Apt mirror. Only used for K8s proxy charms with Juju version lower than 2.9.4" + security-apt-mirror: + type: string + description: "Security Apt mirror. Only used for K8s proxy charms with Juju version lower than 2.9.4" diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/metadata.yaml b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/metadata.yaml new file mode 100644 index 0000000000000000000000000000000000000000..2aa055aaaae42f9726035da3bf371fdded9938af --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/metadata.yaml @@ -0,0 +1,24 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. +name: sshproxy +description: | + This is a basic example of an SSHProxy Charm for OSM +summary: | + This charm should be used as a base for any Proxy Charm (SSH based) +series: + # - focal + # - bionic + # - xenial + - kubernetes +deployment: + mode: operator +peers: + proxypeer: + interface: proxypeer +provides: + interface: + interface: interface +tags: + - osm + - proxycharm + - ssh diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/requirements-dev.txt b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/requirements-dev.txt new file mode 100644 index 0000000000000000000000000000000000000000..eded44146a5877d5d81b343988b516c4acaa4573 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/requirements-dev.txt @@ -0,0 +1,2 @@ +-r requirements.txt +flake8 diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/requirements.txt b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..1329578b341bc5cc8a39340968c8315cda2b553b --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/requirements.txt @@ -0,0 +1,3 @@ +ops +packaging +git+https://github.com/charmed-osm/charms.osm#egg=charms.osm diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/run_tests b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/run_tests new file mode 100755 index 0000000000000000000000000000000000000000..08ec01e05a8965a5009902a6732adf13c027add6 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/run_tests @@ -0,0 +1,16 @@ +#!/bin/sh -e +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. + +if [ -z "$VIRTUAL_ENV" -a -d venv/ ]; then + . venv/bin/activate +fi + +if [ -z "$PYTHONPATH" ]; then + export PYTHONPATH=src +else + export PYTHONPATH="src:$PYTHONPATH" +fi + +flake8 +python3 -m unittest -v "$@" diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/src/charm.py b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/src/charm.py new file mode 100755 index 0000000000000000000000000000000000000000..3c5acf3e539eff309b11a485c5386eae51a33c94 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/src/charm.py @@ -0,0 +1,102 @@ +#!/usr/bin/env python3 +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. + +from ops.main import main + +from charms.osm.sshproxy import SSHProxyCharm +from ops.model import ( + ActiveStatus, + MaintenanceStatus, +) + + +class SshproxyCharm(SSHProxyCharm): + def __init__(self, *args): + super().__init__(*args) + + # An example of setting charm state + # that's persistent across events + self.state.set_default(is_started=False) + + if not self.state.is_started: + self.state.is_started = True + + # Register all of the events we want to observe + # Charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + self.framework.observe(self.on.upgrade_charm, self.on_upgrade_charm) + # Charm actions (primitives) + self.framework.observe(self.on.touch_action, self.on_touch_action) + # OSM actions (primitives) + self.framework.observe(self.on.start_action, self.on_start_action) + self.framework.observe(self.on.stop_action, self.on_stop_action) + self.framework.observe(self.on.restart_action, self.on_restart_action) + self.framework.observe(self.on.reboot_action, self.on_reboot_action) + self.framework.observe(self.on.upgrade_action, self.on_upgrade_action) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being installed""" + super().on_start(event) + + def on_upgrade_charm(self, event): + """Upgrade the charm.""" + self.unit.status = MaintenanceStatus("Upgrading charm") + # Do upgrade related stuff + self.unit.status = ActiveStatus("Active") + + def on_touch_action(self, event): + """Touch a file.""" + + if self.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + proxy.scp("/etc/lsb-release", "/home/ubuntu/scp_file") + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + + ############### + # OSM methods # + ############### + def on_start_action(self, event): + """Start the VNF service on the VM.""" + pass + + def on_stop_action(self, event): + """Stop the VNF service on the VM.""" + pass + + def on_restart_action(self, event): + """Restart the VNF service on the VM.""" + pass + + def on_reboot_action(self, event): + """Reboot the VM.""" + if self.unit.is_leader(): + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("sudo reboot") + if len(stderr): + event.fail(stderr) + else: + event.fail("Unit is not leader") + return + + def on_upgrade_action(self, event): + """Upgrade the VNF service on the VM.""" + pass + + +if __name__ == "__main__": + main(SshproxyCharm) diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/tests/__init__.py b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/tests/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/tests/test_charm.py b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/tests/test_charm.py new file mode 100644 index 0000000000000000000000000000000000000000..f5dead17eec656cd298624bc9c6cd667021cabad --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/tests/test_charm.py @@ -0,0 +1,34 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. + +import unittest +from unittest.mock import Mock, call + +from ops.testing import Harness +from charm import SshproxyCharm + + +class TestCharm(unittest.TestCase): + @unittest.mock.patch("charms.osm.sshproxy.SSHProxy.run") + def test_touch_action(self, mock_ssh_proxy): + mock_ssh_proxy.return_value = ("stdout", None) + harness = Harness(SshproxyCharm) + harness.set_leader(is_leader=True) + harness.begin() + action_event = Mock(params={"filename": "/home/ubuntu/asd"}) + harness.charm.on_touch_action(action_event) + + self.assertTrue(action_event.set_results.called) + self.assertEqual( + action_event.set_results.call_args, + call({"output": "stdout"}), + ) + + def test_touch_action_fail(self): + harness = Harness(SshproxyCharm) + harness.set_leader(is_leader=False) + harness.begin() + action_event = Mock(params={"filename": "/home/ubuntu/asd"}) + harness.charm.on_touch_action(action_event) + + self.assertEqual(action_event.fail.call_args, [("Unit is not leader",)]) diff --git a/charm-packages/cmr_no_relation_vnf/charms/simple-requires.charm b/charm-packages/cmr_no_relation_vnf/charms/simple-requires.charm new file mode 100644 index 0000000000000000000000000000000000000000..40a9be58185de5298637a53a94b08b2b890f558b Binary files /dev/null and b/charm-packages/cmr_no_relation_vnf/charms/simple-requires.charm differ diff --git a/charm-packages/cmr_no_relation_vnf/charms/sshproxy.charm b/charm-packages/cmr_no_relation_vnf/charms/sshproxy.charm new file mode 100644 index 0000000000000000000000000000000000000000..8a42ddf2a5249c8a5922daca6572685b53e0a7a1 Binary files /dev/null and b/charm-packages/cmr_no_relation_vnf/charms/sshproxy.charm differ diff --git a/charm-packages/cmr_no_relation_vnf/cloud_init/cloud-config.txt b/charm-packages/cmr_no_relation_vnf/cloud_init/cloud-config.txt new file mode 100755 index 0000000000000000000000000000000000000000..36c8d1bf2cdebbc4e50d1e8348003f64f419cd0b --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/cloud_init/cloud-config.txt @@ -0,0 +1,12 @@ +#cloud-config +password: osm4u +chpasswd: { expire: False } +ssh_pwauth: True + +write_files: +- content: | + # My new helloworld file + + owner: root:root + permissions: '0644' + path: /root/helloworld.txt diff --git a/charm-packages/cmr_no_relation_vnf/cmr_no_relation_vnfd.yaml b/charm-packages/cmr_no_relation_vnf/cmr_no_relation_vnfd.yaml new file mode 100644 index 0000000000000000000000000000000000000000..fac3e0d81e7a0435e6f60d662bc94d214a6bb2a1 --- /dev/null +++ b/charm-packages/cmr_no_relation_vnf/cmr_no_relation_vnfd.yaml @@ -0,0 +1,144 @@ +vnfd: + description: + A VNF consisting of 1 VDU connected to two external VL, and one for + data and another one for management + df: + - id: default-df + instantiation-level: + - id: default-instantiation-level + vdu-level: + - number-of-instances: 1 + vdu-id: simple_requires + - number-of-instances: 1 + vdu-id: simple_provides + vdu-profile: + - id: simple_requires + min-number-of-instances: 1 + - id: simple_provides + min-number-of-instances: 1 + lcm-operations-configuration: + operate-vnf-op-config: + day1-2: + - id: cross_model_no_relation-vnf + config-access: + ssh-access: + default-user: ubuntu + required: true + execution-environment-list: + - id: simple-provides-proxy-ee + juju: + charm: sshproxy.charm + proxy: true + cloud: k8s + external-connection-point-ref: provides-mgmt-ext + initial-config-primitive: + - seq: 1 + name: config + execution-environment-ref: simple-provides-proxy-ee + parameter: + - name: ssh-hostname + value: + - name: ssh-username + value: ubuntu + - seq: 2 + name: touch + execution-environment-ref: simple-provides-proxy-ee + parameter: + - data-type: STRING + name: filename + value: /home/ubuntu/first-touch + config-primitive: + - name: touch + execution-environment-ref: simple-provides-proxy-ee + parameter: + - data-type: STRING + default-value: /home/ubuntu/touched + name: filename + - id: simple_requires + config-access: + ssh-access: + default-user: ubuntu + required: true + execution-environment-list: + - id: simple-requires-ee + juju: + charm: simple-requires.charm + proxy: false + external-connection-point-ref: requires-mgmt-ext + initial-config-primitive: + - seq: 1 + name: touch + execution-environment-ref: simple-requires-ee + parameter: + - data-type: STRING + name: filename + value: /home/ubuntu/first-touch + config-primitive: + - name: touch + execution-environment-ref: simple-requires-ee + parameter: + - data-type: STRING + default-value: /home/ubuntu/touched + name: filename + ext-cpd: + - id: requires-mgmt-ext + int-cpd: + cpd: simple_requires-eth0-int + vdu-id: simple_requires + - id: provides-mgmt-ext + int-cpd: + cpd: simple_provides-eth0-int + vdu-id: simple_provides + id: cross_model_no_relation-vnf + mgmt-cp: provides-mgmt-ext + product-name: cross_model_no_relation-vnf + sw-image-desc: + - id: ubuntu18.04 + image: ubuntu18.04 + name: ubuntu18.04 + vdu: + - cloud-init-file: cloud-config.txt + id: simple_requires + int-cpd: + - id: simple_requires-eth0-int + virtual-network-interface-requirement: + - name: simple_requires-eth0 + position: 1 + virtual-interface: + type: PARAVIRT + name: simple_requires + sw-image-desc: ubuntu18.04 + virtual-compute-desc: simple_requires-compute + virtual-storage-desc: + - simple_requires-storage + - cloud-init-file: cloud-config.txt + id: simple_provides + int-cpd: + - id: simple_provides-eth0-int + virtual-network-interface-requirement: + - name: simple_provides-eth0 + position: 1 + virtual-interface: + type: PARAVIRT + name: simple_provides + sw-image-desc: ubuntu18.04 + virtual-compute-desc: simple_provides-compute + virtual-storage-desc: + - simple_provides-storage + version: 1.0 + virtual-compute-desc: + - id: simple_requires-compute + virtual-cpu: + num-virtual-cpu: 1 + virtual-memory: + size: 1.0 + - id: simple_provides-compute + virtual-cpu: + num-virtual-cpu: 1 + virtual-memory: + size: 1.0 + virtual-storage-desc: + - id: simple_requires-storage + size-of-storage: 10 + - id: simple_provides-storage + size-of-storage: 10 diff --git a/charm-packages/proxy_native_relation_ns/icons/osm.png b/charm-packages/cmr_no_relation_vnf/icons/osm.png similarity index 100% rename from charm-packages/proxy_native_relation_ns/icons/osm.png rename to charm-packages/cmr_no_relation_vnf/icons/osm.png diff --git a/charm-packages/cmr_relation_ns/cmr_relation_nsd.yaml b/charm-packages/cmr_relation_ns/cmr_relation_nsd.yaml new file mode 100644 index 0000000000000000000000000000000000000000..8c3c6419a9fb639eccaa0172fc08e8165b3c9c8a --- /dev/null +++ b/charm-packages/cmr_relation_ns/cmr_relation_nsd.yaml @@ -0,0 +1,54 @@ +nsd: + nsd: + - description: NS with 2 VNFs with cloudinit connected by datanet and mgmtnet VLs + df: + - id: default-df + vnf-profile: + - id: "1" + virtual-link-connectivity: + - constituent-cpd-id: + - constituent-base-element-id: "1" + constituent-cpd-id: provides-mgmt-ext + - constituent-base-element-id: "1" + constituent-cpd-id: requires-mgmt-ext + - constituent-base-element-id: "1" + constituent-cpd-id: requires-mgmt-kdu-ext + virtual-link-profile-id: mgmtnet + vnfd-id: cross_model_relation-vnf + - id: "2" + virtual-link-connectivity: + - constituent-cpd-id: + - constituent-base-element-id: "1" + constituent-cpd-id: provides-mgmt-ext + - constituent-base-element-id: "1" + constituent-cpd-id: requires-mgmt-ext + virtual-link-profile-id: mgmtnet + vnfd-id: cross_model_no_relation-vnf + - id: "3" + virtual-link-connectivity: + - constituent-cpd-id: + - constituent-base-element-id: "1" + constituent-cpd-id: provides-mgmt-ext + - constituent-base-element-id: "1" + constituent-cpd-id: requires-mgmt-ext + virtual-link-profile-id: mgmtnet + vnfd-id: cross_model_no_relation-vnf + id: cross_model_relation-ns + name: cross_model_relation-ns + version: "1.0" + virtual-link-desc: + - id: mgmtnet + mgmt-network: "true" + vnfd-id: + - cross_model_relation-vnf + - cross_model_no_relation-vnf + ns-configuration: + relation: + - name: relation + provider: + vnf-profile-id: "2" + endpoint: interface + requirer: + vnf-profile-id: "3" + vdu-profile-id: simple_requires + endpoint: interface diff --git a/charm-packages/cmr_relation_ns/icons/osm.png b/charm-packages/cmr_relation_ns/icons/osm.png new file mode 100644 index 0000000000000000000000000000000000000000..62012d2a2b491bdcd536d62c3c3c863c0d8c1b33 Binary files /dev/null and b/charm-packages/cmr_relation_ns/icons/osm.png differ diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/actions.yaml b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/actions.yaml new file mode 100644 index 0000000000000000000000000000000000000000..f9882c47bba960254e0381e5b5ab1c0688de6cf5 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/actions.yaml @@ -0,0 +1,54 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# 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. +## +touch: + description: "Touch a file on the VNF." + params: + filename: + description: "The name of the file to touch." + type: string + default: "" + required: + - filename + +# Standard OSM functions +start: + description: "Stop the service on the VNF." +stop: + description: "Stop the service on the VNF." +restart: + description: "Stop the service on the VNF." +reboot: + description: "Reboot the VNF virtual machine." +upgrade: + description: "Upgrade the software on the VNF." + +# Required by charms.osm.sshproxy +run: + description: "Run an arbitrary command" + params: + command: + description: "The command to execute." + type: string + default: "" + required: + - command +generate-ssh-key: + description: "Generate a new SSH keypair for this unit. This will replace any existing previously generated keypair." +verify-ssh-credentials: + description: "Verify that this unit can authenticate with server specified by ssh-hostname and ssh-username." +get-ssh-public-key: + description: "Get the public SSH key for this unit." diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/config.yaml b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..93e3cab01c0843418c57e4bc918eb933f2daf934 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/config.yaml @@ -0,0 +1,41 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# 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. +## +options: + ssh-hostname: + type: string + default: "" + description: "The hostname or IP address of the machine to" + ssh-username: + type: string + default: "" + description: "The username to login as." + ssh-password: + type: string + default: "" + description: "The password used to authenticate." + ssh-public-key: + type: string + default: "" + description: "The public key of this unit." + ssh-key-type: + type: string + default: "rsa" + description: "The type of encryption to use for the SSH key." + ssh-key-bits: + type: int + default: 4096 + description: "The number of bits to use for the SSH key." diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/install b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/install new file mode 100755 index 0000000000000000000000000000000000000000..e23b12b7bcfddfd49d4efbc1b0ac72d92579778a --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/install @@ -0,0 +1,65 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys + +sys.path.append("lib") + +from charms.osm.sshproxy import SSHProxyCharm +from ops.main import main + +class MySSHProxyCharm(SSHProxyCharm): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + """Called when the charm is being installed""" + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being started""" + super().on_start(event) + + def on_touch_action(self, event): + """Touch a file.""" + + if self.model.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + +if __name__ == "__main__": + main(MySSHProxyCharm) + diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/start b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/start new file mode 100755 index 0000000000000000000000000000000000000000..e23b12b7bcfddfd49d4efbc1b0ac72d92579778a --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/start @@ -0,0 +1,65 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys + +sys.path.append("lib") + +from charms.osm.sshproxy import SSHProxyCharm +from ops.main import main + +class MySSHProxyCharm(SSHProxyCharm): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + """Called when the charm is being installed""" + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being started""" + super().on_start(event) + + def on_touch_action(self, event): + """Touch a file.""" + + if self.model.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + +if __name__ == "__main__": + main(MySSHProxyCharm) + diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/upgrade-charm b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/upgrade-charm new file mode 100755 index 0000000000000000000000000000000000000000..e23b12b7bcfddfd49d4efbc1b0ac72d92579778a --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/hooks/upgrade-charm @@ -0,0 +1,65 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys + +sys.path.append("lib") + +from charms.osm.sshproxy import SSHProxyCharm +from ops.main import main + +class MySSHProxyCharm(SSHProxyCharm): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + """Called when the charm is being installed""" + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being started""" + super().on_start(event) + + def on_touch_action(self, event): + """Touch a file.""" + + if self.model.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + +if __name__ == "__main__": + main(MySSHProxyCharm) + diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/lib/charms b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/lib/charms new file mode 120000 index 0000000000000000000000000000000000000000..5abf77aa5a04fddc6d4eb9d0d6d17e36fd00272a --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/lib/charms @@ -0,0 +1 @@ +../mod/charms.osm/charms/ \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/lib/ops b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/lib/ops new file mode 120000 index 0000000000000000000000000000000000000000..c36dab1ed4a93aee97a31b0eba0438852c5e05bf --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/lib/ops @@ -0,0 +1 @@ +../mod/operator/ops/ \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/metadata.yaml b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/metadata.yaml new file mode 100644 index 0000000000000000000000000000000000000000..76b268bfca697808056fb7386913e592df4b508d --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/metadata.yaml @@ -0,0 +1,30 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +name: simple-ha-proxy +summary: A simple example proxy charm +description: | + Simple proxy charm is an example charm used in OSM Hackfests +series: + - xenial + - bionic +peers: + proxypeer: + interface: proxypeer +provides: + interface: + interface: interface \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/src/charm.py b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/src/charm.py new file mode 100755 index 0000000000000000000000000000000000000000..1092fc34023c21e26eeb7f5cb81876c9d5b21c44 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_provides_proxy/src/charm.py @@ -0,0 +1,73 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys + +sys.path.append("lib") + +from charms.osm.sshproxy import SSHProxyCharm +from ops.main import main + +class MySSHProxyCharm(SSHProxyCharm): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + self.framework.observe( + self.on.interface_relation_changed, self.on_interface_relation_changed + ) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + """Called when the charm is being installed""" + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being started""" + super().on_start(event) + + def on_touch_action(self, event): + """Touch a file.""" + + if self.model.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + + def on_interface_relation_changed(self, event): + parameter = "Hello" + event.relation.data[self.model.unit]["parameter"] = parameter + self.model.unit.status = ActiveStatus("Parameter sent: {}".format(parameter)) + + +if __name__ == "__main__": + main(MySSHProxyCharm) diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/actions.yaml b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/actions.yaml new file mode 100644 index 0000000000000000000000000000000000000000..53a706b4eba7347764c4711b7077146e72241de4 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/actions.yaml @@ -0,0 +1,25 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# 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. +## +touch: + description: "Touch a file on the VNF." + params: + filename: + description: "The name of the file to touch." + type: string + default: "" + required: + - filename diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/charmcraft.yaml b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/charmcraft.yaml new file mode 100644 index 0000000000000000000000000000000000000000..98f146b8dad5207ca673a7d6d2f5e570d03e0113 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/charmcraft.yaml @@ -0,0 +1,34 @@ +# Copyright 2021 Canonical Ltd. +# +# 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. +# +# For those usages not covered by the Apache License, Version 2.0 please +# contact: legal@canonical.com +# +# To get in touch with the maintainers, please contact: +# osm-charmers@lists.launchpad.net +## + +type: charm +bases: + - build-on: + - name: ubuntu + channel: "20.04" + architectures: ["amd64"] + run-on: + - name: ubuntu + channel: "20.04" + architectures: [amd64] +parts: + charm: + build-packages: [git] diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/config.yaml b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..2be62318c6ce27156e4af585494b36d0c2b802f8 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/config.yaml @@ -0,0 +1,17 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# 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. +## +options: {} \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/metadata.yaml b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/metadata.yaml new file mode 100644 index 0000000000000000000000000000000000000000..071f8fa8d2b605f85a78f2322ba8c096c65e1326 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/metadata.yaml @@ -0,0 +1,28 @@ +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +name: simple-native-requires +summary: A simple native charm +description: | + Simple native charm +series: + - bionic + - xenial + - focal +requires: + interface: + interface: interface \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/requirements.txt b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..95534d009733936b25808078f8f70b14b92da644 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/requirements.txt @@ -0,0 +1 @@ +ops \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/src/charm.py b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/src/charm.py new file mode 100755 index 0000000000000000000000000000000000000000..c243dc90a31ba2fb5c14143a5d658f7b8dfd2dcc --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/simple_requires/src/charm.py @@ -0,0 +1,80 @@ +#!/usr/bin/env python3 +## +# Copyright 2020 Canonical Ltd. +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +## + +import sys +import subprocess +import logging + +sys.path.append("lib") + +from ops.charm import CharmBase +from ops.main import main +from ops.model import ActiveStatus + +logger = logging.getLogger(__name__) + +class MyNativeCharm(CharmBase): + + def __init__(self, framework, key): + super().__init__(framework, key) + + # Listen to charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + + # Listen to the touch action event + self.framework.observe(self.on.touch_action, self.on_touch_action) + + # Listen to relation changed + self.framework.observe( + self.on.interface_relation_changed, self.on_interface_relation_changed + ) + def on_config_changed(self, event): + """Handle changes in configuration""" + self.model.unit.status = ActiveStatus() + + def on_install(self, event): + """Called when the charm is being installed""" + self.model.unit.status = ActiveStatus() + + def on_start(self, event): + """Called when the charm is being started""" + self.model.unit.status = ActiveStatus() + + def on_touch_action(self, event): + """Touch a file.""" + + filename = event.params["filename"] + try: + subprocess.run(["touch", filename], check=True) + event.set_results({"created": True, "filename": filename}) + except subprocess.CalledProcessError as e: + event.fail("Action failed: {}".format(e)) + self.model.unit.status = ActiveStatus() + + def on_interface_relation_changed(self, event): + logger.debug("RELATION DATA: {}".format(dict(event.relation.data[event.unit]))) + parameter = event.relation.data[event.unit].get("parameter") + if parameter: + self.model.unit.status = ActiveStatus("Parameter received: {}".format(parameter)) + + +if __name__ == "__main__": + main(MyNativeCharm) + diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.flake8 b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.flake8 new file mode 100644 index 0000000000000000000000000000000000000000..8ef84fcd43f3b7a46768c31b20f36cab48ffdfe0 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.flake8 @@ -0,0 +1,9 @@ +[flake8] +max-line-length = 99 +select: E,W,F,C,N +exclude: + venv + .git + build + dist + *.egg_info diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.gitignore b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..948414822ae161179ba6afcfd7a2222afb8905c6 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.gitignore @@ -0,0 +1,10 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. + +__pycache__ +*.pyc +.vscode +venv +sshproxy.charm +build +__pycache__ \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.jujuignore b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.jujuignore new file mode 100644 index 0000000000000000000000000000000000000000..6ccd559eabeae93e4d23215fa450130fa9b37ace --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/.jujuignore @@ -0,0 +1,3 @@ +/venv +*.py[cod] +*.charm diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/LICENSE b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..94a9ed024d3859793618152ea559a168bbcbb5e2 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/README.md b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/README.md new file mode 100644 index 0000000000000000000000000000000000000000..06752f602017030685d07c650edb3e97486520e6 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/README.md @@ -0,0 +1,131 @@ +# sshproxy + +## Description + +SSHProxy Charm example for Open Source MANO. + +The purpose of this charm is to operate a VNF via SSH. For this, the charm should know the hostname of the VNF (ip address), and the username. The charm will be in a blocked state until it has the hostname, username, and the credentials for SSH-ing to the VNF. Both hostname and username are set via config, with `ssh-hostname` and `ssh-username` respectively. + +There are two ways of specifying the credentials: password, keys. (See next section) + + +## Usage + +This charm works for both LXD and K8s. By default, it will work on LXD. To make it work in K8s, just change the following in the `metadata.yaml` + +```yaml +series: +# - focal +# - bionic +# - xenial + - kubernetes + deployment: + mode: operator +``` + +### Prepare the environment: + +- LXD: + +```bash +sudo snap install juju --classic +juju bootstrap lxd +juju add-model test +``` + +- K8s: + +```bash +sudo snap install juju --classic +sudo snap install microk8s --classic +sudo microk8s.status --wait-ready +sudo microk8s.enable storage dns +juju bootstrap microk8s +juju add-model test +``` + +### Deploying charm: + +```bash +charmcraft build +juju deploy ./sshproxy.charm +``` + +### Configuring the charm: + +First of all, set the username and hostname of the VNF: + +```bash +juju config sshproxy ssh-hostname= \ + ssh-username= +``` + +#### Mirrors + +To workaround this [bug](https://bugs.launchpad.net/juju/+bug/1929399), use the following configurations of the charm to specify the urls of apt and security mirrors. + +```bash +juju config sshproxy apt-mirror= \ + security-apt-mirror= +``` + +### Credentials + +There are two ways to set up the credentials for the charm to be able to SSH the VNF. + +With password: + +```bash +juju config sshproxy ssh-password= +``` + +With public keys: + +1. First get the public key from the charm + +```bash +$ juju run-action sshproxy/0 get-ssh-public-key --wait +unit-sshproxy-0: + UnitId: sshproxy/0 + id: "12" + results: + pubkey: | + ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQC0IgSXMsu/5tY9QjsQfiAqcs6MBMO/7BDJB1ohbJFfvFrPiGg3+5FohKOsgu3SPiZbBhTITmI1YdaiZK7Dye2tHUfQKXhPFVFFVRtyWG6U/QJqEn+6OvAhjladcBlah4cb//r8V2Lvk/PshBJPzgvYSNJOhMhpfAMc7SMMpS8VxGBDIuTE0JFlHcRALJy3YBg70DPea2xrLsxqfA2pTA33KcjK2GyLgfOcZavmkqudEA/WaFb0xCY16TB/hDQBSwZm3l2kJ2aHyAWyWMmLNGL0TT14HUQKR1a8NS/kAnKY/yQf04dKoicmCvl4B3ndIYFT5Pq9b07mVfZvEH5Blle/x48iUF6JHWH2383SXwZfGy3XcX+lRx3u+IIkzS/Pmgt175JVdpu8bktk1c3Ekc0aL9v1gJ8rmZo+C6cilBoaziPfbqIatGPeGxnTDdw0JSfpxUGIQF4H98VOdWf3cHGC1hJZubZt0MGYeK4bk7GfsVPMlGaBWDyTaBQ5d9dHGxJpJX5OMBCDD4MfBYvg9IlgsVr1vDbpB4OFoAmQqFgnUWxRg2w0Iv3HBeMCvvOMM7DBOjwgjgbwa693Oyt/Rxd3GOwvy6vRQkFTgVS6f69SyIMCj9aIl1zxkIcOsfM5aU6vgio1BVWt9Xrj1TA3dTYJ7fkC5LJetqJ1knO67u67ww== root@juju-73fac6-2 + status: completed + timing: + completed: 2020-11-18 15:42:03 +0000 UTC + enqueued: 2020-11-18 15:42:00 +0000 UTC + started: 2020-11-18 15:42:03 +0000 UTC +``` +2. Inject that key in `~/.ssh/authorized_keys` at the VNF +3. Verify the ssh credentials + +```bash +$ juju run-action sshproxy/0 verify-ssh-credentials --wait +unit-sshproxy-0: + UnitId: sshproxy/0 + id: "14" + results: + verified: "True" + status: completed + timing: + completed: 2020-11-18 15:39:30 +0000 UTC + enqueued: 2020-11-18 15:39:29 +0000 UTC + started: 2020-11-18 15:39:29 +0000 UTC +``` + + +## Developing + +Create and activate a virtualenv with the development requirements: + + virtualenv -p python3 venv + source venv/bin/activate + pip install -r requirements-dev.txt + +## Testing + +The Python operator framework includes a very nice harness for testing +operator behaviour without full deployment. Just `run_tests`: + + ./run_tests diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/actions.yaml b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/actions.yaml new file mode 100644 index 0000000000000000000000000000000000000000..07987d2c26ec9b507818300b2f115464ca0d6830 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/actions.yaml @@ -0,0 +1,44 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. +# +# This is only an example, and you should edit to suit your needs. +# If you don't need actions, you can remove the file entirely. +# It ties in to the example _on_fortune_action handler in src/charm.py +touch: + description: "Touch a file on the VNF." + params: + filename: + description: "The name of the file to touch." + type: string + default: "" + required: + - filename + +# Standard OSM functions +start: + description: "Stop the service on the VNF." +stop: + description: "Stop the service on the VNF." +restart: + description: "Stop the service on the VNF." +reboot: + description: "Reboot the VNF virtual machine." +upgrade: + description: "Upgrade the software on the VNF." + +# Required by charms.osm.sshproxy +run: + description: "Run an arbitrary command" + params: + command: + description: "The command to execute." + type: string + default: "" + required: + - command +generate-ssh-key: + description: "Generate a new SSH keypair for this unit. This will replace any existing previously generated keypair." +verify-ssh-credentials: + description: "Verify that this unit can authenticate with server specified by ssh-hostname and ssh-username." +get-ssh-public-key: + description: "Get the public SSH key for this unit." diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/charmcraft.yaml b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/charmcraft.yaml new file mode 100644 index 0000000000000000000000000000000000000000..98f146b8dad5207ca673a7d6d2f5e570d03e0113 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/charmcraft.yaml @@ -0,0 +1,34 @@ +# Copyright 2021 Canonical Ltd. +# +# 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. +# +# For those usages not covered by the Apache License, Version 2.0 please +# contact: legal@canonical.com +# +# To get in touch with the maintainers, please contact: +# osm-charmers@lists.launchpad.net +## + +type: charm +bases: + - build-on: + - name: ubuntu + channel: "20.04" + architectures: ["amd64"] + run-on: + - name: ubuntu + channel: "20.04" + architectures: [amd64] +parts: + charm: + build-packages: [git] diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/config.yaml b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..adf2d8a11dfa13c7a75f6d934bf594ad06f911de --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/config.yaml @@ -0,0 +1,40 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. +# +# This is only an example, and you should edit to suit your needs. +# If you don't need config, you can remove the file entirely. +options: + ssh-hostname: + type: string + default: "" + description: "The hostname or IP address of the machine to" + ssh-username: + type: string + default: "" + description: "The username to login as." + ssh-password: + type: string + default: "" + description: "The password used to authenticate." + # ssh-private-key: + # type: string + # default: "" + # description: "DEPRECATED. The private ssh key to be used to authenticate." + ssh-public-key: + type: string + default: "" + description: "The public key of this unit." + ssh-key-type: + type: string + default: "rsa" + description: "The type of encryption to use for the SSH key." + ssh-key-bits: + type: int + default: 4096 + description: "The number of bits to use for the SSH key." + apt-mirror: + type: string + description: "Apt mirror. Only used for K8s proxy charms with Juju version lower than 2.9.4" + security-apt-mirror: + type: string + description: "Security Apt mirror. Only used for K8s proxy charms with Juju version lower than 2.9.4" diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/metadata.yaml b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/metadata.yaml new file mode 100644 index 0000000000000000000000000000000000000000..2aa055aaaae42f9726035da3bf371fdded9938af --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/metadata.yaml @@ -0,0 +1,24 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. +name: sshproxy +description: | + This is a basic example of an SSHProxy Charm for OSM +summary: | + This charm should be used as a base for any Proxy Charm (SSH based) +series: + # - focal + # - bionic + # - xenial + - kubernetes +deployment: + mode: operator +peers: + proxypeer: + interface: proxypeer +provides: + interface: + interface: interface +tags: + - osm + - proxycharm + - ssh diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/requirements-dev.txt b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/requirements-dev.txt new file mode 100644 index 0000000000000000000000000000000000000000..eded44146a5877d5d81b343988b516c4acaa4573 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/requirements-dev.txt @@ -0,0 +1,2 @@ +-r requirements.txt +flake8 diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/requirements.txt b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..1329578b341bc5cc8a39340968c8315cda2b553b --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/requirements.txt @@ -0,0 +1,3 @@ +ops +packaging +git+https://github.com/charmed-osm/charms.osm#egg=charms.osm diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/run_tests b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/run_tests new file mode 100755 index 0000000000000000000000000000000000000000..08ec01e05a8965a5009902a6732adf13c027add6 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/run_tests @@ -0,0 +1,16 @@ +#!/bin/sh -e +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. + +if [ -z "$VIRTUAL_ENV" -a -d venv/ ]; then + . venv/bin/activate +fi + +if [ -z "$PYTHONPATH" ]; then + export PYTHONPATH=src +else + export PYTHONPATH="src:$PYTHONPATH" +fi + +flake8 +python3 -m unittest -v "$@" diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/src/charm.py b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/src/charm.py new file mode 100755 index 0000000000000000000000000000000000000000..3c5acf3e539eff309b11a485c5386eae51a33c94 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/src/charm.py @@ -0,0 +1,102 @@ +#!/usr/bin/env python3 +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. + +from ops.main import main + +from charms.osm.sshproxy import SSHProxyCharm +from ops.model import ( + ActiveStatus, + MaintenanceStatus, +) + + +class SshproxyCharm(SSHProxyCharm): + def __init__(self, *args): + super().__init__(*args) + + # An example of setting charm state + # that's persistent across events + self.state.set_default(is_started=False) + + if not self.state.is_started: + self.state.is_started = True + + # Register all of the events we want to observe + # Charm events + self.framework.observe(self.on.config_changed, self.on_config_changed) + self.framework.observe(self.on.install, self.on_install) + self.framework.observe(self.on.start, self.on_start) + self.framework.observe(self.on.upgrade_charm, self.on_upgrade_charm) + # Charm actions (primitives) + self.framework.observe(self.on.touch_action, self.on_touch_action) + # OSM actions (primitives) + self.framework.observe(self.on.start_action, self.on_start_action) + self.framework.observe(self.on.stop_action, self.on_stop_action) + self.framework.observe(self.on.restart_action, self.on_restart_action) + self.framework.observe(self.on.reboot_action, self.on_reboot_action) + self.framework.observe(self.on.upgrade_action, self.on_upgrade_action) + + def on_config_changed(self, event): + """Handle changes in configuration""" + super().on_config_changed(event) + + def on_install(self, event): + super().on_install(event) + + def on_start(self, event): + """Called when the charm is being installed""" + super().on_start(event) + + def on_upgrade_charm(self, event): + """Upgrade the charm.""" + self.unit.status = MaintenanceStatus("Upgrading charm") + # Do upgrade related stuff + self.unit.status = ActiveStatus("Active") + + def on_touch_action(self, event): + """Touch a file.""" + + if self.unit.is_leader(): + filename = event.params["filename"] + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("touch {}".format(filename)) + proxy.scp("/etc/lsb-release", "/home/ubuntu/scp_file") + event.set_results({"output": stdout}) + else: + event.fail("Unit is not leader") + return + + ############### + # OSM methods # + ############### + def on_start_action(self, event): + """Start the VNF service on the VM.""" + pass + + def on_stop_action(self, event): + """Stop the VNF service on the VM.""" + pass + + def on_restart_action(self, event): + """Restart the VNF service on the VM.""" + pass + + def on_reboot_action(self, event): + """Reboot the VM.""" + if self.unit.is_leader(): + proxy = self.get_ssh_proxy() + stdout, stderr = proxy.run("sudo reboot") + if len(stderr): + event.fail(stderr) + else: + event.fail("Unit is not leader") + return + + def on_upgrade_action(self, event): + """Upgrade the VNF service on the VM.""" + pass + + +if __name__ == "__main__": + main(SshproxyCharm) diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/tests/__init__.py b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/tests/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/tests/test_charm.py b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/tests/test_charm.py new file mode 100644 index 0000000000000000000000000000000000000000..f5dead17eec656cd298624bc9c6cd667021cabad --- /dev/null +++ b/charm-packages/cmr_relation_vnf/charms/ops/sshproxy-operator/tests/test_charm.py @@ -0,0 +1,34 @@ +# Copyright 2020 David Garcia +# See LICENSE file for licensing details. + +import unittest +from unittest.mock import Mock, call + +from ops.testing import Harness +from charm import SshproxyCharm + + +class TestCharm(unittest.TestCase): + @unittest.mock.patch("charms.osm.sshproxy.SSHProxy.run") + def test_touch_action(self, mock_ssh_proxy): + mock_ssh_proxy.return_value = ("stdout", None) + harness = Harness(SshproxyCharm) + harness.set_leader(is_leader=True) + harness.begin() + action_event = Mock(params={"filename": "/home/ubuntu/asd"}) + harness.charm.on_touch_action(action_event) + + self.assertTrue(action_event.set_results.called) + self.assertEqual( + action_event.set_results.call_args, + call({"output": "stdout"}), + ) + + def test_touch_action_fail(self): + harness = Harness(SshproxyCharm) + harness.set_leader(is_leader=False) + harness.begin() + action_event = Mock(params={"filename": "/home/ubuntu/asd"}) + harness.charm.on_touch_action(action_event) + + self.assertEqual(action_event.fail.call_args, [("Unit is not leader",)]) diff --git a/charm-packages/cmr_relation_vnf/charms/simple-requires.charm b/charm-packages/cmr_relation_vnf/charms/simple-requires.charm new file mode 100644 index 0000000000000000000000000000000000000000..40a9be58185de5298637a53a94b08b2b890f558b Binary files /dev/null and b/charm-packages/cmr_relation_vnf/charms/simple-requires.charm differ diff --git a/charm-packages/cmr_relation_vnf/charms/sshproxy.charm b/charm-packages/cmr_relation_vnf/charms/sshproxy.charm new file mode 100644 index 0000000000000000000000000000000000000000..8a42ddf2a5249c8a5922daca6572685b53e0a7a1 Binary files /dev/null and b/charm-packages/cmr_relation_vnf/charms/sshproxy.charm differ diff --git a/charm-packages/cmr_relation_vnf/cloud_init/cloud-config.txt b/charm-packages/cmr_relation_vnf/cloud_init/cloud-config.txt new file mode 100755 index 0000000000000000000000000000000000000000..36c8d1bf2cdebbc4e50d1e8348003f64f419cd0b --- /dev/null +++ b/charm-packages/cmr_relation_vnf/cloud_init/cloud-config.txt @@ -0,0 +1,12 @@ +#cloud-config +password: osm4u +chpasswd: { expire: False } +ssh_pwauth: True + +write_files: +- content: | + # My new helloworld file + + owner: root:root + permissions: '0644' + path: /root/helloworld.txt diff --git a/charm-packages/cmr_relation_vnf/cmr_relation_vnfd.yaml b/charm-packages/cmr_relation_vnf/cmr_relation_vnfd.yaml new file mode 100644 index 0000000000000000000000000000000000000000..8e9764ffd0f92361f4137be8f34a6ddb34609a60 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/cmr_relation_vnfd.yaml @@ -0,0 +1,222 @@ +vnfd: + description: + A VNF consisting of 1 VDU connected to two external VL, and one for + data and another one for management + df: + - id: default-df + kdu-resource-profile: + - id: kdu-simple-provides + kdu-name: native-kdu + resource-name: provides + min-number-of-instances: 1 + max-number-of-instances: 5 + instantiation-level: + - id: default-instantiation-level + vdu-level: + - number-of-instances: 1 + vdu-id: simple_requires + - number-of-instances: 1 + vdu-id: simple_requires_kdu + - number-of-instances: 1 + vdu-id: simple_provides + vdu-profile: + - id: simple_requires + min-number-of-instances: 1 + - id: simple_requires_kdu + min-number-of-instances: 1 + - id: simple_provides + min-number-of-instances: 1 + lcm-operations-configuration: + operate-vnf-op-config: + day1-2: + - id: cross_model_relation-vnf + config-access: + ssh-access: + default-user: ubuntu + required: true + execution-environment-list: + - id: simple-provides-proxy-ee + juju: + charm: sshproxy.charm + proxy: true + cloud: k8s + external-connection-point-ref: provides-mgmt-ext + initial-config-primitive: + - seq: 1 + name: config + execution-environment-ref: simple-provides-proxy-ee + parameter: + - name: ssh-hostname + value: + - name: ssh-username + value: ubuntu + - seq: 2 + name: touch + execution-environment-ref: simple-provides-proxy-ee + parameter: + - data-type: STRING + name: filename + value: /home/ubuntu/first-touch + config-primitive: + - name: touch + execution-environment-ref: simple-provides-proxy-ee + parameter: + - data-type: STRING + default-value: /home/ubuntu/touched + name: filename + relation: + - name: relation + provider: + endpoint: interface + requirer: + endpoint: interface + vdu-profile-id: simple_requires + - name: relation-with-kdu + provider: + kdu-resource-profile-id: kdu-simple-provides + endpoint: interface + requirer: + vdu-profile-id: simple_requires_kdu + endpoint: interface + - id: simple_requires + config-access: + ssh-access: + default-user: ubuntu + required: true + execution-environment-list: + - id: simple-requires-ee + juju: + charm: simple-requires.charm + proxy: false + external-connection-point-ref: requires-mgmt-ext + initial-config-primitive: + - seq: 1 + name: touch + execution-environment-ref: simple-requires-ee + parameter: + - data-type: STRING + name: filename + value: /home/ubuntu/first-touch + config-primitive: + - name: touch + execution-environment-ref: simple-requires-ee + parameter: + - data-type: STRING + default-value: /home/ubuntu/touched + name: filename + - id: simple_requires_kdu + config-access: + ssh-access: + default-user: ubuntu + required: true + execution-environment-list: + - id: simple-requires-ee + juju: + charm: simple-requires.charm + proxy: false + external-connection-point-ref: requires-mgmt-kdu-ext + initial-config-primitive: + - seq: 1 + name: touch + execution-environment-ref: simple-requires-ee + parameter: + - data-type: STRING + name: filename + value: /home/ubuntu/first-touch + config-primitive: + - name: touch + execution-environment-ref: simple-requires-ee + parameter: + - data-type: STRING + default-value: /home/ubuntu/touched + name: filename + ext-cpd: + - id: requires-mgmt-ext + int-cpd: + cpd: simple_requires-eth0-int + vdu-id: simple_requires + - id: requires-mgmt-kdu-ext + int-cpd: + cpd: simple_requires_kdu-eth0-int + vdu-id: simple_requires_kdu + - id: provides-mgmt-ext + int-cpd: + cpd: simple_provides-eth0-int + vdu-id: simple_provides + id: cross_model_relation-vnf + mgmt-cp: provides-mgmt-ext + product-name: cross_model_relation-vnf + sw-image-desc: + - id: ubuntu18.04 + image: ubuntu18.04 + name: ubuntu18.04 + kdu: + - name: native-kdu + juju-bundle: bundle.yaml + vdu: + - cloud-init-file: cloud-config.txt + id: simple_requires + int-cpd: + - id: simple_requires-eth0-int + virtual-network-interface-requirement: + - name: simple_requires-eth0 + position: 1 + virtual-interface: + type: PARAVIRT + name: simple_requires + sw-image-desc: ubuntu18.04 + virtual-compute-desc: simple_requires-compute + virtual-storage-desc: + - simple_requires-storage + - cloud-init-file: cloud-config.txt + id: simple_requires_kdu + int-cpd: + - id: simple_requires_kdu-eth0-int + virtual-network-interface-requirement: + - name: simple_requires_kdu-eth0 + position: 1 + virtual-interface: + type: PARAVIRT + name: simple_requires_kdu + sw-image-desc: ubuntu18.04 + virtual-compute-desc: simple_requires_kdu-compute + virtual-storage-desc: + - simple_requires_kdu-storage + - cloud-init-file: cloud-config.txt + id: simple_provides + int-cpd: + - id: simple_provides-eth0-int + virtual-network-interface-requirement: + - name: simple_provides-eth0 + position: 1 + virtual-interface: + type: PARAVIRT + name: simple_provides + sw-image-desc: ubuntu18.04 + virtual-compute-desc: simple_provides-compute + virtual-storage-desc: + - simple_provides-storage + version: 1.0 + virtual-compute-desc: + - id: simple_requires-compute + virtual-cpu: + num-virtual-cpu: 1 + virtual-memory: + size: 1.0 + - id: simple_requires_kdu-compute + virtual-cpu: + num-virtual-cpu: 1 + virtual-memory: + size: 1.0 + - id: simple_provides-compute + virtual-cpu: + num-virtual-cpu: 1 + virtual-memory: + size: 1.0 + virtual-storage-desc: + - id: simple_requires-storage + size-of-storage: 10 + - id: simple_requires_kdu-storage + size-of-storage: 10 + - id: simple_provides-storage + size-of-storage: 10 diff --git a/charm-packages/cmr_relation_vnf/icons/osm.png b/charm-packages/cmr_relation_vnf/icons/osm.png new file mode 100644 index 0000000000000000000000000000000000000000..62012d2a2b491bdcd536d62c3c3c863c0d8c1b33 Binary files /dev/null and b/charm-packages/cmr_relation_vnf/icons/osm.png differ diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/bundle.yaml b/charm-packages/cmr_relation_vnf/juju-bundles/bundle.yaml new file mode 100644 index 0000000000000000000000000000000000000000..170e64badc517a44ba115b8a92878e90a403f07b --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/bundle.yaml @@ -0,0 +1,8 @@ +description: Bundle with a charm providing an endpoint +bundle: kubernetes +applications: + provides: + charm: './charms/provides.charm' + scale: 1 + resources: + placeholder-image: ubuntu:latest diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/.gitignore b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..2c3f0e5ed7915b3800370e2f37f7661e29df6742 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/.gitignore @@ -0,0 +1,7 @@ +venv/ +build/ +*.charm + +.coverage +__pycache__/ +*.py[cod] diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/.jujuignore b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/.jujuignore new file mode 100644 index 0000000000000000000000000000000000000000..6ccd559eabeae93e4d23215fa450130fa9b37ace --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/.jujuignore @@ -0,0 +1,3 @@ +/venv +*.py[cod] +*.charm diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/LICENSE b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..d645695673349e3947e8e5ae42332d0ac3164cd7 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/LICENSE @@ -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 [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. diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/charmcraft.yaml b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/charmcraft.yaml new file mode 100644 index 0000000000000000000000000000000000000000..048d45441c7e0645e78ac0b7b392bb510408b49a --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/charmcraft.yaml @@ -0,0 +1,10 @@ +# Learn more about charmcraft.yaml configuration at: +# https://juju.is/docs/sdk/charmcraft-config +type: "charm" +bases: + - build-on: + - name: "ubuntu" + channel: "20.04" + run-on: + - name: "ubuntu" + channel: "20.04" diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/config.yaml b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..8bfefb04622a052e9e21cd696af0cb8d7f53f4f1 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/config.yaml @@ -0,0 +1,10 @@ +# Copyright 2021 David Garcia +# See LICENSE file for licensing details. +# +# TEMPLATE-TODO: change this example to suit your needs. +# If you don't need a config, you can remove the file entirely. +# It ties in to the example _on_config_changed handler in src/charm.py +# +# Learn more about config at: https://juju.is/docs/sdk/config + +options: {} \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/metadata.yaml b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/metadata.yaml new file mode 100644 index 0000000000000000000000000000000000000000..60567255444f0d2053a3d3bb718e41d4fba3a101 --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/metadata.yaml @@ -0,0 +1,19 @@ +# Copyright 2021 David Garcia +# See LICENSE file for licensing details. +name: provides +display-name: charm with a provides endpoint +description: charm with a provides endpoint +summary: charm with a provides endpoint + +containers: + placeholder: + resource: placeholder-image + +resources: + placeholder-image: + type: oci-image + description: placeholder image + +provides: + interface: + interface: interface \ No newline at end of file diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/requirements.txt b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..5d6fa963fcbdb9bfdb9fc2c8049e172bc6b6405b --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/requirements.txt @@ -0,0 +1 @@ +ops >= 1.2.0 diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/src/charm.py b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/src/charm.py new file mode 100755 index 0000000000000000000000000000000000000000..7e831e3d58a100f1b0fefc3e86fd1be41ddd49ba --- /dev/null +++ b/charm-packages/cmr_relation_vnf/juju-bundles/charms/ops/provides-operator/src/charm.py @@ -0,0 +1,33 @@ +#!/usr/bin/env python3 +# Copyright 2021 David Garcia +# See LICENSE file for licensing details. +import logging + +from ops.charm import CharmBase +from ops.main import main +from ops.model import ActiveStatus + +logger = logging.getLogger(__name__) + + +class ProvidesCharm(CharmBase): + """Charm the service.""" + + def __init__(self, *args): + super().__init__(*args) + self.framework.observe(self.on.install, self._on_install) + self.framework.observe( + self.on.interface_relation_changed, self.on_interface_relation_changed + ) + + def _on_install(self, event): + self.unit.status = ActiveStatus() + + def on_interface_relation_changed(self, event): + parameter = "Hello" + event.relation.data[self.model.unit]["parameter"] = parameter + self.unit.status = ActiveStatus("Parameter sent: {}".format(parameter)) + + +if __name__ == "__main__": + main(ProvidesCharm) diff --git a/charm-packages/cmr_relation_vnf/juju-bundles/charms/provides.charm b/charm-packages/cmr_relation_vnf/juju-bundles/charms/provides.charm new file mode 100644 index 0000000000000000000000000000000000000000..18e5258bae00a337d8e513992744a3b431bdd980 Binary files /dev/null and b/charm-packages/cmr_relation_vnf/juju-bundles/charms/provides.charm differ