--- /dev/null
+deps/
+builds/
+
--- /dev/null
+# Overview
+
+This is a [Juju] layer intended to ease the development of charms that need
+to execute commands over SSH, such as proxy charms.
+
+# What is a proxy charm?
+
+A proxy charm is a limited type of charm that does not interact with software running on the same host, such as controlling and configuring a remote device (a static VM image, a router/switch, etc.). It cannot take advantage of some of Juju's key features, such as [scaling], [relations], and [leadership].
+
+Proxy charms are primarily a stop-gap, intended to prototype quickly, with the end goal being to develop it into a full-featured charm, which installs and executes code on the same machine as the charm is running.
+
+# Integration
+
+After you've [created your charm], open `interfaces.yaml` and add
+`layer:sshproxy` to the includes stanza, as shown below:
+```
+includes: ['layer:basic', 'layer:sshproxy']
+```
+
+## Reactive states
+
+This layer will set the following states:
+
+- `sshproxy.configured` This state is set when SSH credentials have been supplied to the charm.
+
+
+## Example
+In `reactive/mycharm.py`, you can add logic to execute commands over SSH. This
+example is run via a `start` action, and starts a service running on a remote
+host.
+```
+...
+import charms.sshproxy
+
+
+@when('sshproxy.configured')
+@when('actions.start')
+def start():
+ """ Execute's the command, via the start action` using the
+ configured SSH credentials
+ """
+ sshproxy.ssh("service myservice start")
+
+```
+
+## Actions
+This layer includes a built-in `run` action useful for debugging or running arbitrary commands:
+
+```
+$ juju run-action mycharm/0 run command=hostname
+Action queued with id: 014b72f3-bc02-4ecb-8d38-72bce03bbb63
+
+$ juju show-action-output 014b72f3-bc02-4ecb-8d38-72bce03bbb63
+results:
+ output: juju-66a5f3-11
+status: completed
+timing:
+ completed: 2016-10-27 19:53:49 +0000 UTC
+ enqueued: 2016-10-27 19:53:44 +0000 UTC
+ started: 2016-10-27 19:53:48 +0000 UTC
+
+```
+## Known Limitations and Issues
+
+### Security issues
+
+- Password and key-based authentications are supported, with the caveat that
+both (password and private key) are stored plaintext within the Juju controller.
+
+# Configuration and Usage
+
+This layer adds the following configuration options:
+- ssh-hostname
+- ssh-username
+- ssh-password
+- ssh-private-key
+
+Once [configure] those values at any time. Once they are set, the `sshproxy.configured` state flag will be toggled:
+
+```
+juju deploy mycharm ssh-hostname=10.10.10.10 ssh-username=ubuntu ssh-password=yourpassword
+```
+or
+```
+juju deploy mycharm ssh-hostname=10.10.10.10 ssh-username=ubuntu ssh-private-key="`cat ~/.ssh/id_rsa`"
+```
+
+
+# Contact Information
+Homepage: https://github.com/AdamIsrael/layer-sshproxy
+
+[Juju]: https://jujucharms.com/about
+[configure]: https://jujucharms.com/docs/2.0/charms-config
+[scaling]: https://jujucharms.com/docs/2.0/charms-scaling
+[relations]: https://jujucharms.com/docs/2.0/charms-relations
+[leadership]: https://jujucharms.com/docs/2.0/developer-leadership
+[created your charm]: https://jujucharms.com/docs/2.0/developer-getting-started
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+run:
+ description: "Run an arbitrary command"
+ params:
+ command:
+ description: "The command to execute."
+ type: string
+ default: ""
+ required:
+ - command
--- /dev/null
+#!/usr/bin/env python3
+##
+# Copyright 2016 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.reactive import main
+from charms.reactive import set_state
+from charmhelpers.core.hookenv import action_fail, action_name
+
+"""
+`set_state` only works here because it's flushed to disk inside the `main()`
+loop. remove_state will need to be called inside the action method.
+"""
+set_state('actions.{}'.format(action_name()))
+
+try:
+ main()
+except Exception as e:
+ action_fail(repr(e))
--- /dev/null
+##
+# Copyright 2016 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-private-key:
+ type: string
+ default: ""
+ description: "The private ssh key to be used to authenticate."
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+includes: ['layer:basic'] # if you use any interfaces, add them here
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+from charmhelpers.core.hookenv import (
+ config,
+)
+import io
+import paramiko
+
+from subprocess import (
+ Popen,
+ CalledProcessError,
+ PIPE,
+)
+
+
+def _run(cmd, env=None):
+ """ Run a command, either on the local machine or remotely via SSH. """
+ if isinstance(cmd, str):
+ cmd = cmd.split(' ') if ' ' in cmd else [cmd]
+
+ cfg = config()
+ if all(k in cfg for k in ['ssh-hostname', 'ssh-username',
+ 'ssh-password', 'ssh-private-key']):
+ host = cfg['ssh-hostname']
+ user = cfg['ssh-username']
+ passwd = cfg['ssh-password']
+ key = cfg['ssh-private-key']
+
+ if host and user and (passwd or key):
+ return ssh(cmd, host, user, passwd, key)
+
+ p = Popen(cmd,
+ env=env,
+ shell=True,
+ stdout=PIPE,
+ stderr=PIPE)
+ stdout, stderr = p.communicate()
+ retcode = p.poll()
+ if retcode > 0:
+ raise CalledProcessError(returncode=retcode,
+ cmd=cmd,
+ output=stderr.decode("utf-8").strip())
+ return (stdout.decode('utf-8').strip(), stderr.decode('utf-8').strip())
+
+
+def get_ssh_client(host, user, password=None, key=None):
+ """Return a connected Paramiko ssh object"""
+
+ client = paramiko.SSHClient()
+ client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+
+ pkey = None
+ if key:
+ f = io.StringIO(key)
+ pkey = paramiko.RSAKey.from_private_key(f)
+
+ ###########################################################################
+ # There is a bug in some versions of OpenSSH 4.3 (CentOS/RHEL 5) where #
+ # the server may not send the SSH_MSG_USERAUTH_BANNER message except when #
+ # responding to an auth_none request. For example, paramiko will attempt #
+ # to use password authentication when a password is set, but the server #
+ # could deny that, instead requesting keyboard-interactive. The hack to #
+ # workaround this is to attempt a reconnect, which will receive the right #
+ # banner, and authentication can proceed. See the following for more info #
+ # https://github.com/paramiko/paramiko/issues/432 #
+ # https://github.com/paramiko/paramiko/pull/438 #
+ ###########################################################################
+
+ try:
+ client.connect(host, port=22, username=user,
+ password=password, pkey=pkey)
+ except paramiko.ssh_exception.SSHException as e:
+ if 'Error reading SSH protocol banner' == str(e):
+ # Once more, with feeling
+ client.connect(host, port=22, username=user,
+ password=password, pkey=pkey)
+ pass
+ else:
+ raise paramiko.ssh_exception.SSHException(e)
+
+ return client
+
+
+def sftp(local_file, remote_file, host, user, password=None, key=None):
+ """Copy a local file to a remote host"""
+ client = get_ssh_client(host, user, password, key)
+
+ # Create an sftp connection from the underlying transport
+ sftp = paramiko.SFTPClient.from_transport(client.get_transport())
+ sftp.put(local_file, remote_file)
+ client.close()
+
+
+def ssh(cmd, host, user, password=None, key=None):
+ """ Run an arbitrary command over SSH. """
+ client = get_ssh_client(host, user, password, key)
+
+ cmds = ' '.join(cmd)
+ stdin, stdout, stderr = client.exec_command(cmds, get_pty=True)
+ retcode = stdout.channel.recv_exit_status()
+ client.close() # @TODO re-use connections
+ if retcode > 0:
+ output = stderr.read().strip()
+ raise CalledProcessError(returncode=retcode, cmd=cmd,
+ output=output)
+ return (
+ stdout.read().decode('utf-8').strip(),
+ stderr.read().decode('utf-8').strip()
+ )
--- /dev/null
+##
+# Copyright 2016 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: sshproxy
+summary: Layer to copy files to or run commands on a remote host over ssh
+maintainer: Adam Israel <adam.israel@canonical.com>
+description: |
+ This layer is intended to provide common ssh functionality, such as
+ running a command on a remote host.
+series:
+ - trusty
+ - xenial
+tags:
+ # Replace "misc" with one or more whitelisted tags from this list:
+ # https://jujucharms.com/docs/stable/authors-charm-metadata
+ - misc
+subordinate: false
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+from charmhelpers.core.hookenv import (
+ action_fail,
+ action_get,
+ action_set,
+ config,
+)
+from charms.reactive import (
+ remove_state,
+ set_state,
+ when,
+)
+import charms.sshproxy
+import subprocess
+
+
+@when('config.changed')
+def ssh_configured():
+ """ Checks to see if the charm is configured with SSH credentials. If so,
+ set a state flag that can be used to execute ssh-only actions.
+
+ For example:
+
+ @when('sshproxy.configured')
+ def run_remote_command(cmd):
+ ...
+
+ @when_not('sshproxy.configured')
+ def run_local_command(cmd):
+ ...
+ """
+ cfg = config()
+ if all(k in cfg for k in ['ssh-hostname', 'ssh-username',
+ 'ssh-password', 'ssh-private-key']):
+ set_state('sshproxy.configured')
+ else:
+ remove_state('sshproxy.configured')
+
+
+@when('actions.run')
+def run_command():
+ """
+ Run an arbitrary command, either locally or over SSH with the configured
+ credentials.
+ """
+ try:
+ cmd = action_get('command')
+ output, err = charms.sshproxy._run(cmd)
+ if len(err):
+ action_fail("Command '{}' returned error code {}".format(cmd, err))
+ else:
+ action_set({'output': output})
+ except subprocess.CalledProcessError as e:
+ action_fail('Command failed: %s (%s)' %
+ (' '.join(e.cmd), str(e.output)))
+ finally:
+ remove_state('actions.run')
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+#!/bin/bash
+
+sudo add-apt-repository ppa:juju/stable -y
+sudo apt-get update
+sudo apt-get install amulet python-requests -y
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+#!/usr/bin/python3
+
+import amulet
+import requests
+import unittest
+import string
+import random
+
+
+class TestCharm(unittest.TestCase):
+ user = None
+ passwd = None
+
+ def id_generator(self, size=6, chars=string.ascii_uppercase + string.digits):
+ return ''.join(random.choice(chars) for _ in range(size))
+
+ def setUp(self):
+
+ # Setup random user/password
+ self.user = self.id_generator()
+ self.passwd = self.id_generator()
+
+ self.d = amulet.Deployment()
+
+ self.d.add('sshproxy')
+ self.d.add('ubuntu')
+
+ self.d.expose('sshproxy')
+
+ self.d.setup(timeout=900)
+ self.d.sentry.wait()
+
+ # Add
+ ubuntu_0 = d.sentry['ubuntu'][0]
+ ubuntu_0.ssh("sudo adduser {}".format(self.user))
+ ubuntu_0.ssh("echo '{}' | sudo passwd {} --stdin".format(self.passwd, self.user))
+
+ self.unit = self.d.sentry['sshproxy'][0]
+
+ def test_service(self):
+
+ # Configure the unit
+
+ # Run a command
+
+ # Verify the output
+
+ # test we can access over http
+ # page = requests.get('http://{}'.format(self.unit.info['public-address']))
+ # self.assertEqual(page.status_code, 200)
+ # Now you can use self.d.sentry[SERVICE][UNIT] to address each of the units and perform
+ # more in-depth steps. Each self.d.sentry[SERVICE][UNIT] has the following methods:
+ # - .info - An array of the information of that unit from Juju
+ # - .file(PATH) - Get the details of a file on that unit
+ # - .file_contents(PATH) - Get plain text output of PATH file from that unit
+ # - .directory(PATH) - Get details of directory
+ # - .directory_contents(PATH) - List files and folders in PATH on that unit
+ # - .relation(relation, service:rel) - Get relation data from return service
+ pass
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+paramiko>=1.16.0,<1.17
--- /dev/null
+# vnfproxy
+
+## Overview
+
+This charm layer is intended for use by vendors who wish to integrate with
+OSM. The current release of OSM only supports a lightweight version of Juju
+charms, which we will refer to as "proxy charms". Consider the diagram below:
+
+```
++---------------------+ +---------------------+
+| <----+ |
+| Resource | | Service |
+| Orchestrator (RO) +----> Orchestrator (SO) |
+| | | |
++------------------+--+ +-------+----^--------+
+ | | |
+ | | |
+ | | |
+ +-----v-----+ +-v----+--+
+ | <-------+ |
+ | Virtual | | Proxy |
+ | Machine | | Charm |
+ | +-------> |
+ +-----------+ +---------+
+```
+
+The Virtual Machine (VM) is created by the Resource Orchestrator (RO), at the
+request of the Service Orchestrator (SO). Once the VM has been created, a
+"proxy charm" is deployed in order to facilitate operations between the SO and
+your service running within the VM.
+
+As such, a proxy charm will expose a number of "actions" that are run via the
+SO. By default, the following actions are exposed:
+
+```bash
+actions
+├── reboot
+├── restart
+├── run
+├── start
+└── stop
+```
+
+Some actions, such as `run` and `reboot`, do not require any additional configuration. `start`, `stop` and `restart`, however, will require you to
+implement the command(s) required to interact with your service.
+
+## Usage
+
+Create the framework for your proxy charm:
+
+```bash
+$ charm create pingpong
+$ cd pingpong
+```
+
+Modify `layer.yaml` to the following:
+```yaml
+includes:
+ - layer:basic
+ - layer:vnfproxy
+```
+
+The `metadata.yaml` describes your service. It should look similar to the following:
+
+```yaml
+name: vnfproxy
+summary: A layer for developing OSM "proxy" charms.
+maintainer: Adam Israel <adam.israel@canonical.com>
+description: |
+ VNF "proxy" charms are a lightweight version of a charm that, rather than
+ installing software on the same machine, execute commands over an ssh channel.
+series:
+ - trusty
+ - xenial
+tags:
+ - osm
+ - vnf
+subordinate: false
+```
+
+Implement the default action(s) you wish to support by adding the following code to reactive/pingpong.py and fill in the cmd to be run:
+
+```python
+@when('actions.start')
+def start():
+ err = ''
+ try:
+ cmd = ""
+ result, err = charms.sshproxy._run(cmd)
+ except:
+ action_fail('command failed:' + err)
+ else:
+ action_set({'outout': result})
+ finally:
+ remove_flag('actions.start')
+
+
+@when('actions.stop')
+def stop():
+ err = ''
+ try:
+ # Enter the command to stop your service(s)
+ cmd = "service myname stop"
+ result, err = charms.sshproxy._run(cmd)
+ except:
+ action_fail('command failed:' + err)
+ else:
+ action_set({'outout': result})
+ finally:
+ remove_flag('actions.stop')
+
+
+@when('actions.restart')
+def restart():
+ err = ''
+ try:
+ # Enter the command to restart your service(s)
+ cmd = "service myname restart"
+ result, err = charms.sshproxy._run(cmd)
+ except:
+ action_fail('command failed:' + err)
+ else:
+ action_set({'outout': result})
+ finally:
+ remove_flag('actions.restart')
+```
+
+Rename `README.ex` to `README.md` and describe your application and its usage.
+
+-- fix this. there are cases where the config is useful -- Delete `config.yaml`, since the charm's configuration will be driven by the SO.
+
+Create the `actions.yaml` file; this will describe the additional operations you would like to perform on or against your service.
+
+```yaml
+set-server:
+ description: "Set the target IP address and port"
+ params:
+ server-ip:
+ description: "IP on which the target service is listening."
+ type: string
+ default: ""
+ server-port:
+ description: "Port on which the target service is listening."
+ type: integer
+ default: 5555
+ required:
+ - server-ip
+set-rate:
+ description: "Set the rate of packet generation."
+ params:
+ rate:
+ description: "Packet rate."
+ type: integer
+ default: 5
+get-stats:
+ description: "Get the stats."
+get-state:
+ description: "Get the admin state of the target service."
+get-rate:
+ description: "Get the rate set on the target service."
+get-server:
+ description: "Get the target server and IP set"
+```
+
+
+Once you've implemented your actions, you need to compile the various charm layers:
+```bash
+$ charm build
+
+```
+
+## Contact
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+start:
+ description: "Stop the service"
+stop:
+ description: "Stop the service"
+restart:
+ description: "Stop the service"
+reboot:
+ description: "Reboot the machine"
--- /dev/null
+#!/usr/bin/env python3
+##
+# Copyright 2016 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.reactive import main
+from charms.reactive import set_state
+from charmhelpers.core.hookenv import action_fail
+
+"""
+`set_state` only works here because it's flushed to disk inside the `main()`
+loop. remove_state will need to be called inside the action method.
+"""
+set_state('actions.reboot')
+
+try:
+ main()
+except Exception as e:
+ action_fail(repr(e))
--- /dev/null
+#!/usr/bin/env python3
+##
+# Copyright 2016 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.reactive import main
+from charms.reactive import set_state
+from charmhelpers.core.hookenv import action_fail
+
+"""
+`set_state` only works here because it's flushed to disk inside the `main()`
+loop. remove_state will need to be called inside the action method.
+"""
+set_state('actions.restart')
+
+try:
+ main()
+except Exception as e:
+ action_fail(repr(e))
--- /dev/null
+#!/usr/bin/env python3
+##
+# Copyright 2016 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.reactive import main
+from charms.reactive import set_state
+from charmhelpers.core.hookenv import action_fail
+
+"""
+`set_state` only works here because it's flushed to disk inside the `main()`
+loop. remove_state will need to be called inside the action method.
+"""
+set_state('actions.start')
+
+try:
+ main()
+except Exception as e:
+ action_fail(repr(e))
--- /dev/null
+#!/usr/bin/env python3
+##
+# Copyright 2016 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.reactive import main
+from charms.reactive import set_state
+from charmhelpers.core.hookenv import action_fail
+
+"""
+`set_state` only works here because it's flushed to disk inside the `main()`
+loop. remove_state will need to be called inside the action method.
+"""
+set_state('actions.stop')
+
+try:
+ main()
+except Exception as e:
+ action_fail(repr(e))
--- /dev/null
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>\r
+<!-- Created with Inkscape (http://www.inkscape.org/) -->\r
+\r
+<svg\r
+ xmlns:dc="http://purl.org/dc/elements/1.1/"\r
+ xmlns:cc="http://creativecommons.org/ns#"\r
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"\r
+ xmlns:svg="http://www.w3.org/2000/svg"\r
+ xmlns="http://www.w3.org/2000/svg"\r
+ xmlns:xlink="http://www.w3.org/1999/xlink"\r
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"\r
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"\r
+ width="96"\r
+ height="96"\r
+ id="svg6517"\r
+ version="1.1"\r
+ inkscape:version="0.48+devel r12274"\r
+ sodipodi:docname="Juju_charm_icon_template.svg">\r
+ <defs\r
+ id="defs6519">\r
+ <linearGradient\r
+ inkscape:collect="always"\r
+ xlink:href="#Background"\r
+ id="linearGradient6461"\r
+ gradientUnits="userSpaceOnUse"\r
+ x1="0"\r
+ y1="970.29498"\r
+ x2="144"\r
+ y2="970.29498"\r
+ gradientTransform="matrix(0,-0.66666669,0.6660448,0,-866.25992,731.29077)" />\r
+ <linearGradient\r
+ id="Background">\r
+ <stop\r
+ id="stop4178"\r
+ offset="0"\r
+ style="stop-color:#b8b8b8;stop-opacity:1" />\r
+ <stop\r
+ id="stop4180"\r
+ offset="1"\r
+ style="stop-color:#c9c9c9;stop-opacity:1" />\r
+ </linearGradient>\r
+ <filter\r
+ style="color-interpolation-filters:sRGB;"\r
+ inkscape:label="Inner Shadow"\r
+ id="filter1121">\r
+ <feFlood\r
+ flood-opacity="0.59999999999999998"\r
+ flood-color="rgb(0,0,0)"\r
+ result="flood"\r
+ id="feFlood1123" />\r
+ <feComposite\r
+ in="flood"\r
+ in2="SourceGraphic"\r
+ operator="out"\r
+ result="composite1"\r
+ id="feComposite1125" />\r
+ <feGaussianBlur\r
+ in="composite1"\r
+ stdDeviation="1"\r
+ result="blur"\r
+ id="feGaussianBlur1127" />\r
+ <feOffset\r
+ dx="0"\r
+ dy="2"\r
+ result="offset"\r
+ id="feOffset1129" />\r
+ <feComposite\r
+ in="offset"\r
+ in2="SourceGraphic"\r
+ operator="atop"\r
+ result="composite2"\r
+ id="feComposite1131" />\r
+ </filter>\r
+ <filter\r
+ style="color-interpolation-filters:sRGB;"\r
+ inkscape:label="Drop Shadow"\r
+ id="filter950">\r
+ <feFlood\r
+ flood-opacity="0.25"\r
+ flood-color="rgb(0,0,0)"\r
+ result="flood"\r
+ id="feFlood952" />\r
+ <feComposite\r
+ in="flood"\r
+ in2="SourceGraphic"\r
+ operator="in"\r
+ result="composite1"\r
+ id="feComposite954" />\r
+ <feGaussianBlur\r
+ in="composite1"\r
+ stdDeviation="1"\r
+ result="blur"\r
+ id="feGaussianBlur956" />\r
+ <feOffset\r
+ dx="0"\r
+ dy="1"\r
+ result="offset"\r
+ id="feOffset958" />\r
+ <feComposite\r
+ in="SourceGraphic"\r
+ in2="offset"\r
+ operator="over"\r
+ result="composite2"\r
+ id="feComposite960" />\r
+ </filter>\r
+ <clipPath\r
+ clipPathUnits="userSpaceOnUse"\r
+ id="clipPath873">\r
+ <g\r
+ transform="matrix(0,-0.66666667,0.66604479,0,-258.25992,677.00001)"\r
+ id="g875"\r
+ inkscape:label="Layer 1"\r
+ style="fill:#ff00ff;fill-opacity:1;stroke:none;display:inline">\r
+ <path\r
+ style="fill:#ff00ff;fill-opacity:1;stroke:none;display:inline"\r
+ d="m 46.702703,898.22775 50.594594,0 C 138.16216,898.22775 144,904.06497 144,944.92583 l 0,50.73846 c 0,40.86071 -5.83784,46.69791 -46.702703,46.69791 l -50.594594,0 C 5.8378378,1042.3622 0,1036.525 0,995.66429 L 0,944.92583 C 0,904.06497 5.8378378,898.22775 46.702703,898.22775 Z"\r
+ id="path877"\r
+ inkscape:connector-curvature="0"\r
+ sodipodi:nodetypes="sssssssss" />\r
+ </g>\r
+ </clipPath>\r
+ <filter\r
+ inkscape:collect="always"\r
+ id="filter891"\r
+ inkscape:label="Badge Shadow">\r
+ <feGaussianBlur\r
+ inkscape:collect="always"\r
+ stdDeviation="0.71999962"\r
+ id="feGaussianBlur893" />\r
+ </filter>\r
+ </defs>\r
+ <sodipodi:namedview\r
+ id="base"\r
+ pagecolor="#ffffff"\r
+ bordercolor="#666666"\r
+ borderopacity="1.0"\r
+ inkscape:pageopacity="0.0"\r
+ inkscape:pageshadow="2"\r
+ inkscape:zoom="4.0745362"\r
+ inkscape:cx="18.514671"\r
+ inkscape:cy="49.018169"\r
+ inkscape:document-units="px"\r
+ inkscape:current-layer="layer1"\r
+ showgrid="true"\r
+ fit-margin-top="0"\r
+ fit-margin-left="0"\r
+ fit-margin-right="0"\r
+ fit-margin-bottom="0"\r
+ inkscape:window-width="1920"\r
+ inkscape:window-height="1029"\r
+ inkscape:window-x="0"\r
+ inkscape:window-y="24"\r
+ inkscape:window-maximized="1"\r
+ showborder="true"\r
+ showguides="true"\r
+ inkscape:guide-bbox="true"\r
+ inkscape:showpageshadow="false">\r
+ <inkscape:grid\r
+ type="xygrid"\r
+ id="grid821" />\r
+ <sodipodi:guide\r
+ orientation="1,0"\r
+ position="16,48"\r
+ id="guide823" />\r
+ <sodipodi:guide\r
+ orientation="0,1"\r
+ position="64,80"\r
+ id="guide825" />\r
+ <sodipodi:guide\r
+ orientation="1,0"\r
+ position="80,40"\r
+ id="guide827" />\r
+ <sodipodi:guide\r
+ orientation="0,1"\r
+ position="64,16"\r
+ id="guide829" />\r
+ </sodipodi:namedview>\r
+ <metadata\r
+ id="metadata6522">\r
+ <rdf:RDF>\r
+ <cc:Work\r
+ rdf:about="">\r
+ <dc:format>image/svg+xml</dc:format>\r
+ <dc:type\r
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />\r
+ <dc:title></dc:title>\r
+ </cc:Work>\r
+ </rdf:RDF>\r
+ </metadata>\r
+ <g\r
+ inkscape:label="BACKGROUND"\r
+ inkscape:groupmode="layer"\r
+ id="layer1"\r
+ transform="translate(268,-635.29076)"\r
+ style="display:inline">\r
+ <path\r
+ style="fill:url(#linearGradient6461);fill-opacity:1;stroke:none;display:inline;filter:url(#filter1121)"\r
+ d="m -268,700.15563 0,-33.72973 c 0,-27.24324 3.88785,-31.13513 31.10302,-31.13513 l 33.79408,0 c 27.21507,0 31.1029,3.89189 31.1029,31.13513 l 0,33.72973 c 0,27.24325 -3.88783,31.13514 -31.1029,31.13514 l -33.79408,0 C -264.11215,731.29077 -268,727.39888 -268,700.15563 Z"\r
+ id="path6455"\r
+ inkscape:connector-curvature="0"\r
+ sodipodi:nodetypes="sssssssss" />\r
+ </g>\r
+ <g\r
+ inkscape:groupmode="layer"\r
+ id="layer3"\r
+ inkscape:label="PLACE YOUR PICTOGRAM HERE"\r
+ style="display:inline" />\r
+ <g\r
+ inkscape:groupmode="layer"\r
+ id="layer2"\r
+ inkscape:label="BADGE"\r
+ style="display:none"\r
+ sodipodi:insensitive="true">\r
+ <g\r
+ style="display:inline"\r
+ transform="translate(-340.00001,-581)"\r
+ id="g4394"\r
+ clip-path="none">\r
+ <g\r
+ id="g855">\r
+ <g\r
+ inkscape:groupmode="maskhelper"\r
+ id="g870"\r
+ clip-path="url(#clipPath873)"\r
+ style="opacity:0.6;filter:url(#filter891)">\r
+ <path\r
+ transform="matrix(1.4999992,0,0,1.4999992,-29.999795,-237.54282)"\r
+ d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"\r
+ sodipodi:ry="12"\r
+ sodipodi:rx="12"\r
+ sodipodi:cy="552.36218"\r
+ sodipodi:cx="252"\r
+ id="path844"\r
+ style="color:#000000;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"\r
+ sodipodi:type="arc" />\r
+ </g>\r
+ <g\r
+ id="g862">\r
+ <path\r
+ sodipodi:type="arc"\r
+ style="color:#000000;fill:#f5f5f5;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"\r
+ id="path4398"\r
+ sodipodi:cx="252"\r
+ sodipodi:cy="552.36218"\r
+ sodipodi:rx="12"\r
+ sodipodi:ry="12"\r
+ d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"\r
+ transform="matrix(1.4999992,0,0,1.4999992,-29.999795,-238.54282)" />\r
+ <path\r
+ transform="matrix(1.25,0,0,1.25,33,-100.45273)"\r
+ d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"\r
+ sodipodi:ry="12"\r
+ sodipodi:rx="12"\r
+ sodipodi:cy="552.36218"\r
+ sodipodi:cx="252"\r
+ id="path4400"\r
+ style="color:#000000;fill:#dd4814;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"\r
+ sodipodi:type="arc" />\r
+ <path\r
+ sodipodi:type="star"\r
+ style="color:#000000;fill:#f5f5f5;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:3;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"\r
+ id="path4459"\r
+ sodipodi:sides="5"\r
+ sodipodi:cx="666.19574"\r
+ sodipodi:cy="589.50385"\r
+ sodipodi:r1="7.2431178"\r
+ sodipodi:r2="4.3458705"\r
+ sodipodi:arg1="1.0471976"\r
+ sodipodi:arg2="1.6755161"\r
+ inkscape:flatsided="false"\r
+ inkscape:rounded="0.1"\r
+ inkscape:randomized="0"\r
+ d="m 669.8173,595.77657 c -0.39132,0.22593 -3.62645,-1.90343 -4.07583,-1.95066 -0.44938,-0.0472 -4.05653,1.36297 -4.39232,1.06062 -0.3358,-0.30235 0.68963,-4.03715 0.59569,-4.47913 -0.0939,-0.44198 -2.5498,-3.43681 -2.36602,-3.8496 0.18379,-0.41279 4.05267,-0.59166 4.44398,-0.81759 0.39132,-0.22593 2.48067,-3.48704 2.93005,-3.4398 0.44938,0.0472 1.81505,3.67147 2.15084,3.97382 0.3358,0.30236 4.08294,1.2817 4.17689,1.72369 0.0939,0.44198 -2.9309,2.86076 -3.11469,3.27355 C 669.9821,591.68426 670.20862,595.55064 669.8173,595.77657 Z"\r
+ transform="matrix(1.511423,-0.16366377,0.16366377,1.511423,-755.37346,-191.93651)" />\r
+ </g>\r
+ </g>\r
+ </g>\r
+ </g>\r
+</svg>\r
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+includes:
+ - layer:basic
+ - layer:sshproxy
--- /dev/null
+##
+# Copyright 2016 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: vnfproxy
+summary: A layer for developing OSM "proxy" charms.
+maintainer: Adam Israel <adam.israel@canonical.com>
+description: |
+ VNF "proxy" charms are a lightweight version of a charm that, rather than
+ installing software on the same machine, execute commands over an ssh channel.
+series:
+ - trusty
+ - xenial
+tags:
+ - osm
+ - vnf
+subordinate: false
--- /dev/null
+from charmhelpers.core.hookenv import (
+ action_fail,
+ action_set,
+)
+
+from charms.reactive import (
+ when,
+ remove_state as remove_flag,
+)
+import charms.sshproxy
+
+
+@when('actions.reboot')
+def reboot():
+ err = ''
+ try:
+ result, err = charms.sshproxy._run("reboot")
+ except:
+ action_fail('command failed:' + err)
+ else:
+ action_set({'outout': result})
+ finally:
+ remove_flag('actions.reboot')
+
+
+###############################################################################
+# Below is an example implementation of the start/stop/restart actions. #
+# To use this, copy the below code into your layer and add the appropriate #
+# command(s) necessary to perform the action. #
+###############################################################################
+
+# @when('actions.start')
+# def start():
+# err = ''
+# try:
+# cmd = "service myname start"
+# result, err = charms.sshproxy._run(cmd)
+# except:
+# action_fail('command failed:' + err)
+# else:
+# action_set({'outout': result})
+# finally:
+# remove_flag('actions.start')
+#
+#
+# @when('actions.stop')
+# def stop():
+# err = ''
+# try:
+# # Enter the command to stop your service(s)
+# cmd = "service myname stop"
+# result, err = charms.sshproxy._run(cmd)
+# except:
+# action_fail('command failed:' + err)
+# else:
+# action_set({'outout': result})
+# finally:
+# remove_flag('actions.stop')
+#
+#
+# @when('actions.restart')
+# def restart():
+# err = ''
+# try:
+# # Enter the command to restart your service(s)
+# cmd = "service myname restart"
+# result, err = charms.sshproxy._run(cmd)
+# except:
+# action_fail('command failed:' + err)
+# else:
+# action_set({'outout': result})
+# finally:
+# remove_flag('actions.restart')
+#
+#
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+#!/bin/bash
+
+sudo add-apt-repository ppa:juju/stable -y
+sudo apt-get update
+sudo apt-get install amulet python-requests -y
--- /dev/null
+##
+# Copyright 2016 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.
+##
+
+#!/usr/bin/python3
+
+import amulet
+import requests
+import unittest
+
+
+class TestCharm(unittest.TestCase):
+ def setUp(self):
+ self.d = amulet.Deployment()
+
+ self.d.add('vnfproxy')
+ self.d.expose('vnfproxy')
+
+ self.d.setup(timeout=900)
+ self.d.sentry.wait()
+
+ self.unit = self.d.sentry['vnfproxy'][0]
+
+ def test_service(self):
+ # test we can access over http
+ page = requests.get('http://{}'.format(self.unit.info['public-address']))
+ self.assertEqual(page.status_code, 200)
+ # Now you can use self.d.sentry[SERVICE][UNIT] to address each of the units and perform
+ # more in-depth steps. Each self.d.sentry[SERVICE][UNIT] has the following methods:
+ # - .info - An array of the information of that unit from Juju
+ # - .file(PATH) - Get the details of a file on that unit
+ # - .file_contents(PATH) - Get plain text output of PATH file from that unit
+ # - .directory(PATH) - Get details of directory
+ # - .directory_contents(PATH) - List files and folders in PATH on that unit
+ # - .relation(relation, service:rel) - Get relation data from return service
+
+
+if __name__ == '__main__':
+ unittest.main()
projects / osm / SO.git / commitdiff
