First commit

.flake8

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

.gitignore

@@ -0,0 +1,8 @@
+.tox/
+venv/
+build/
+*.charm
+
+.coverage
+__pycache__/
+*.py[cod]

.jujuignore

@@ -0,0 +1,3 @@
+/venv
+*.py[cod]
+*.charm

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.

README.md

@@ -0,0 +1,25 @@
+# openstack-loadbalancer
+
+## Description
+
+TODO: Describe your charm in a few paragraphs of Markdown
+
+## Usage
+
+TODO: Provide high-level usage, such as required config or relations
+
+
+## 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

actions.yaml

@@ -0,0 +1,16 @@
+# Copyright 2021 Ubuntu
+# See LICENSE file for licensing details.
+#
+# TEMPLATE-TODO: change this example 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
+#
+# Learn more about actions at: https://juju.is/docs/sdk/actions
+
+fortune:
+  description: Returns a pithy phrase.
+  params:
+    fail:
+      description: "Fail with this message"
+      type: string
+      default: ""

config.yaml

@@ -0,0 +1,14 @@
+# Copyright 2021 Ubuntu
+# 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:
+  thing:
+    default: 🎁
+    description: A thing used by the charm.
+    type: string

metadata.yaml

@@ -0,0 +1,18 @@
+# Copyright 2021 Canonical
+# See LICENSE file for licensing details.
+name: openstack-loadbalancer
+display-name: OpenStack loadbalancer
+maintainer: OpenStack Charmers <openstack-discuss@lists.openstack.org>
+summary: Loadbalance traffic over OpenStack services
+description: |
+  Loadbalance the things
+tags:
+- openstack
+extra-bindings:
+  public:
+series:
+- focal
+- groovy
+provides:
+  loadbalancer:
+    interface: api-endpoints

requirements-dev.txt

@@ -0,0 +1,3 @@
+-r requirements.txt
+coverage
+flake8

requirements.txt

@@ -0,0 +1,2 @@
+ops >= 1.2.0
+git+https://opendev.org/openstack/charm-ops-openstack#egg=ops_openstack

run_tests

@@ -0,0 +1,17 @@
+#!/bin/sh -e
+# Copyright 2021 Ubuntu
+# See LICENSE file for licensing details.
+
+if [ -z "$VIRTUAL_ENV" -a -d venv/ ]; then
+    . venv/bin/activate
+fi
+
+if [ -z "$PYTHONPATH" ]; then
+    export PYTHONPATH="lib:src"
+else
+    export PYTHONPATH="lib:src:$PYTHONPATH"
+fi
+
+flake8
+coverage run --source=src -m unittest -v "$@"
+coverage report -m

src/charm.py

@@ -0,0 +1,137 @@
+#!/usr/bin/env python3
+# Copyright 2021 Ubuntu
+# See LICENSE file for licensing details.
+#
+# Learn more at: https://juju.is/docs/sdk
+
+"""Charm the service.
+
+Refer to the following post for a quick-start guide that will help you
+develop a new k8s charm using the Operator Framework:
+
+    https://discourse.charmhub.io/t/4208
+"""
+import collections
+import jinja2
+import json
+import logging
+import interface_api_endpoints
+import subprocess
+
+from ops.charm import CharmBase
+from ops.framework import StoredState
+from ops.main import main
+from ops.model import ActiveStatus
+
+import ops_openstack.core
+logger = logging.getLogger(__name__)
+
+# defaults
+#   log global
+#   option log-health-checks
+#   timeout connect 5s
+#   timeout client 50s
+#   timeout server 450s
+
+# frontend dashboard_front
+#   mode http
+#   bind *:80
+#   option httplog
+#   redirect scheme https code 301 if !{ ssl_fc }
+
+# frontend dashboard_front_ssl
+#   mode tcp
+#   bind *:443
+#   option tcplog
+#   default_backend dashboard_back_ssl
+
+# backend dashboard_back_ssl
+#   mode tcp
+#   option httpchk GET /
+#   http-check expect status 200
+#   server x <HOST>:<PORT> check-ssl check verify none
+#   server y <HOST>:<PORT> check-ssl check verify none
+#   server z <HOST>:<PORT> check-ssl check verify none
+
+HAPROXY_TEMPLATE = """
+defaults
+  log global
+  option log-health-checks
+  timeout connect 5s
+  timeout client 50s
+  timeout server 450s
+
+{% for service, service_config in endpoints.items() %}
+frontend {{service}}_front
+  mode tcp
+  bind *:{{service_config.frontend_port}}
+  option tcplog
+  default_backend {{service}}_back
+
+backend {{service}}_back
+  mode tcp
+  option httpchk GET /
+  http-check expect status 200
+{% for unit in service_config.members %}
+  server {{ unit.unit_name }} {{ unit.backend_ip }}:{{ unit.backend_port }} check-ssl check verify none
+{% endfor %}
+{% endfor %}
+"""
+
+class OpenstackLoadbalancerCharm(ops_openstack.core.OSBaseCharm):
+    """Charm the service."""
+
+    PACKAGES = ['haproxy']
+    _stored = StoredState()
+
+    def __init__(self, *args):
+        super().__init__(*args)
+        self.api_eps = interface_api_endpoints.APIEndpointsProvides(self)
+        self.framework.observe(self.api_eps.on.ep_ready, self._configure_haproxy)
+        self.unit.status = ActiveStatus()
+
+    def _get_config_from_relation(self):
+        app_config_keys = ['check-type', 'frontend-port']
+        unit_config_keys = ['backend-ip', 'backend-port']
+        app_data = {
+            'endpoints': {}} 
+        for relation in self.model.relations['loadbalancer']:
+            unit = list(relation.units)[0]
+            for ep in json.loads(relation.data[unit].get('endpoints', '[]')):
+                service_type = ep['service-type'].replace('-', '_')
+                app_data['endpoints'][service_type] = {
+                    'members': []}
+                for config in app_config_keys:
+                    app_data['endpoints'][service_type][config.replace('-', '_')] = ep[config]
+        unit_data = {}
+        for relation in self.model.relations['loadbalancer']:
+            for unit in relation.units:
+                eps = json.loads(relation.data[unit].get('endpoints', '[]'))
+                for service in app_data['endpoints'].keys():
+                    unit_config = {}
+                    for ep in eps:
+                        if ep['service-type'].replace('-', '_') == service:
+                            unit_config = ep
+                    unit_config['unit_name'] = unit.name.replace('/', '_')
+                    unit_config = {k.replace('-', '_'):v for k,v in unit_config.items()}
+                    app_data['endpoints'][service]['members'].append(unit_config)
+        return app_data
+
+    def _get_haproxy_config(self):
+        """Generate squid.conf contents."""
+        jinja_env = jinja2.Environment(loader=jinja2.BaseLoader())
+        jinja_template = jinja_env.from_string(HAPROXY_TEMPLATE)
+        ctxt = {}
+        ctxt.update(self._get_config_from_relation())
+        ctxt = {k.replace('-', '_'): v for k, v in ctxt.items()}
+        return jinja_template.render(**ctxt)
+
+    def _configure_haproxy(self, event):
+        with open('/etc/haproxy/haproxy.cfg', 'w') as f:
+            contents = self._get_haproxy_config()
+            f.write(contents)
+        self._stored.is_started =  True
+        subprocess.check_call(['systemctl', 'restart', 'haproxy'])
+
+if __name__ == "__main__":
+    main(OpenstackLoadbalancerCharm)

src/interface_api_endpoints.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+
+import json
+import logging
+import socket
+
+from ops.framework import (
+    StoredState,
+    EventBase,
+    ObjectEvents,
+    EventSource,
+    Object)
+
+class EnpointDataEvent(EventBase):
+    pass
+
+class APIEndpointsEvents(ObjectEvents):
+    ep_ready = EventSource(EnpointDataEvent)
+
+# openstack-loadbalancer: provides
+# ceph-dashboard:requires
+
+class APIEndpointsRequires(Object):
+
+    on = APIEndpointsEvents()
+    _stored = StoredState()
+
+    def __init__(self, charm, relation_name, config_dict):
+        super().__init__(charm, relation_name)
+        self.config_dict = config_dict
+        self.relation_name = relation_name
+        self.framework.observe(charm.on[self.relation_name].relation_changed, self._on_relation_changed)
+
+    def _on_relation_changed(self, event):
+        """Handle the relation-changed event."""
+        # `self.unit` isn't available here, so use `self.model.unit`.
+#        for key in self.config_dict:
+#            event.relation.data[self.model.app][key] = str(self.config_dict[key])
+        event.relation.data[self.model.app]['endpoints'] = str(self.config_dict['endpoints'])
+
+    def update_config(self, config_dict):
+        """Allow for updates to relation."""
+        self.config_dict = config_dict
+        relation = self.model.get_relation(self.relation_name)
+        if relation:
+#            for key in self.config_dict:
+#                relation.data[self.model.app][key] = str(self.config_dict[key])
+            relation.data[self.model.app]['endpoints'] = str(self.config_dict['endpoints'])
+
+
+class APIEndpointsProvides(Object):
+
+    on = APIEndpointsEvents()
+    _stored = StoredState()
+
+    def __init__(self, charm):
+        super().__init__(charm, "loadbalancer")
+        # Observe the relation-changed hook event and bind
+        # self.on_relation_changed() to handle the event.
+        self.framework.observe(charm.on["loadbalancer"].relation_changed, self._on_relation_changed)
+        self.charm = charm
+
+    def _on_relation_changed(self, event):
+        """Handle a change to the ingress relation.
+
+        Confirm we have the fields we expect to receive."""
+        # `self.unit` isn't available here, so use `self.model.unit`.
+        if not self.model.unit.is_leader():
+            return
+
+        self.on.ep_ready.emit()

tests/test_charm.py

@@ -0,0 +1,66 @@
+# Copyright 2021 Ubuntu
+# See LICENSE file for licensing details.
+#
+# Learn more about testing at: https://juju.is/docs/sdk/testing
+
+import unittest
+from unittest.mock import Mock
+
+from charm import OpenstackLoadbalancerCharm
+from ops.model import ActiveStatus
+from ops.testing import Harness
+
+
+class TestCharm(unittest.TestCase):
+    def setUp(self):
+        self.harness = Harness(OpenstackLoadbalancerCharm)
+        self.addCleanup(self.harness.cleanup)
+        self.harness.begin()
+
+    def test_config_changed(self):
+        self.assertEqual(list(self.harness.charm._stored.things), [])
+        self.harness.update_config({"thing": "foo"})
+        self.assertEqual(list(self.harness.charm._stored.things), ["foo"])
+
+    def test_action(self):
+        # the harness doesn't (yet!) help much with actions themselves
+        action_event = Mock(params={"fail": ""})
+        self.harness.charm._on_fortune_action(action_event)
+
+        self.assertTrue(action_event.set_results.called)
+
+    def test_action_fail(self):
+        action_event = Mock(params={"fail": "fail this"})
+        self.harness.charm._on_fortune_action(action_event)
+
+        self.assertEqual(action_event.fail.call_args, [("fail this",)])
+
+    def test_httpbin_pebble_ready(self):
+        # Check the initial Pebble plan is empty
+        initial_plan = self.harness.get_container_pebble_plan("httpbin")
+        self.assertEqual(initial_plan.to_yaml(), "{}\n")
+        # Expected plan after Pebble ready with default config
+        expected_plan = {
+            "services": {
+                "httpbin": {
+                    "override": "replace",
+                    "summary": "httpbin",
+                    "command": "gunicorn -b 0.0.0.0:80 httpbin:app -k gevent",
+                    "startup": "enabled",
+                    "environment": {"thing": "🎁"},
+                }
+            },
+        }
+        # Get the httpbin container from the model
+        container = self.harness.model.unit.get_container("httpbin")
+        # Emit the PebbleReadyEvent carrying the httpbin container
+        self.harness.charm.on.httpbin_pebble_ready.emit(container)
+        # Get the plan now we've run PebbleReady
+        updated_plan = self.harness.get_container_pebble_plan("httpbin").to_dict()
+        # Check we've got the plan we expected
+        self.assertEqual(expected_plan, updated_plan)
+        # Check the service was started
+        service = self.harness.model.unit.get_container("httpbin").get_service("httpbin")
+        self.assertTrue(service.is_running())
+        # Ensure we set an ActiveStatus with no message
+        self.assertEqual(self.harness.model.unit.status, ActiveStatus())