wip: add ns-level relation

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/actions.yaml

+##
+# 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."

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/config.yaml

+##
+# 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."

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/install

+#!/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)
+

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/start

+#!/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)
+

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/hooks/upgrade-charm

+#!/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)
+

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/lib/charms

+../mod/charms.osm/charms/
\ No newline at end of file

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/lib/ops

+../mod/operator/ops/
\ No newline at end of file

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/metadata.yaml

+##
+# 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

charm-packages/cmr_no_relation_vnf/charms/ops/simple_provides_proxy/src/charm.py

+#!/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)

charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/actions.yaml

+##
+# 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

charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/config.yaml

+##
+# 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

charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/metadata.yaml

+##
+# 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

charm-packages/cmr_no_relation_vnf/charms/ops/simple_requires/src/charm.py

+#!/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)
+

charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.flake8

+[flake8]
+max-line-length = 99
+select: E,W,F,C,N
+exclude:
+  venv
+  .git
+  build
+  dist
+  *.egg_info

charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.gitignore

+# Copyright 2020 David Garcia
+# See LICENSE file for licensing details.
+
+__pycache__
+*.pyc
+.vscode
+venv
+sshproxy.charm
+build
+__pycache__
\ No newline at end of file

charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/.jujuignore

+/venv
+*.py[cod]
+*.charm

charm-packages/cmr_no_relation_vnf/charms/ops/sshproxy-operator/README.md

+# 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=<hostname> \
+                     ssh-username=<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=<apt-mirror> \
+                     security-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=<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