Initial baseline of charm

charms/cinder-ceph-k8s/.flake8

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

charms/cinder-ceph-k8s/.gitignore

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

charms/cinder-ceph-k8s/.jujuignore

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

charms/cinder-ceph-k8s/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# charm-cinder-operator
+
+## Developing
+
+Create and activate a virtualenv with the development requirements:
+
+    virtualenv -p python3 venv
+    source venv/bin/activate
+    pip install -r requirements-dev.txt
+
+## Code overview
+
+TEMPLATE-TODO: 
+One of the most important things a consumer of your charm (or library)
+needs to know is what set of functionality it provides. Which categories
+does it fit into? Which events do you listen to? Which libraries do you
+consume? Which ones do you export and how are they used?
+
+## Intended use case
+
+TEMPLATE-TODO:
+Why were these decisions made? What's the scope of your charm?
+
+## Roadmap
+
+If this Charm doesn't fulfill all of the initial functionality you were
+hoping for or planning on, please add a Roadmap or TODO here
+
+## Testing
+
+The Python operator framework includes a very nice harness for testing
+operator behaviour without full deployment. Just `run_tests`:
+
+    ./run_tests

charms/cinder-ceph-k8s/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.

charms/cinder-ceph-k8s/README.md

@@ -0,0 +1,24 @@
+# charm-cinder-operator
+
+## Description
+
+TODO: Describe your charm in a few paragraphs of Markdown
+
+## Usage
+
+TODO: Provide high-level usage, such as required config or relations
+
+
+## Relations
+
+TODO: Provide any relations which are provided or required by your charm
+
+## OCI Images
+
+TODO: Include a link to the default image your charm uses
+
+## Contributing
+
+Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines 
+on enhancements to this charm following best practice guidelines, and
+`CONTRIBUTING.md` for developer guidance.

charms/cinder-ceph-k8s/actions.yaml

@@ -0,0 +1,2 @@
+# NOTE: no actions yet!
+{ }

charms/cinder-ceph-k8s/charmcraft.yaml

@@ -0,0 +1,12 @@
+type: "charm"
+bases:
+  - build-on:
+    - name: "ubuntu"
+      channel: "20.04"
+    run-on:
+    - name: "ubuntu"
+      channel: "20.04"
+parts:
+  charm:
+    build-packages:
+      - git

charms/cinder-ceph-k8s/config.yaml

@@ -0,0 +1,5 @@
+options:
+  debug:
+    default: False
+    description: Enable debug logging.
+    type: boolean

charms/cinder-ceph-k8s/metadata.yaml

@@ -0,0 +1,40 @@
+# Copyright 2021 Canonical Ltd
+# See LICENSE file for licensing details.
+name: sunbeam-cinder-ceph-operator
+summary: OpenStack volume service - Ceph backend
+maintainer: Openstack Charmers <openstack-charmers@lists.ubuntu.com>
+description: |
+  Cinder is the OpenStack project that provides volume management for
+  instances.  This charm provides integration with Ceph storage
+  backends.
+version: 3
+bases:
+  - name: ubuntu
+    channel: 20.04/stable
+tags:
+  - openstack
+  - storage
+  - misc
+
+containers:
+  cinder-volume:
+    resource: cinder-base
+
+resources:
+  cinder-base:
+    type: oci-image
+    description: OCI image for OpenStack Cinder (kolla/cinder-base)
+
+requires:
+  amqp:
+    interface: rabbitmq
+
+provides:
+  ceph-access:
+    interface: cinder-ceph-key
+  storage-backend:
+    interface: cinder-backend
+
+peers:
+  peers:
+    interface: cinder-peer

charms/cinder-ceph-k8s/requirements-dev.txt

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

charms/cinder-ceph-k8s/requirements.txt

@@ -0,0 +1,4 @@
+# ops >= 1.2.0
+jinja2
+git+https://github.com/canonical/operator@2875e73e#egg=ops
+git+https://opendev.org/openstack/charm-ops-openstack#egg=ops_openstack

charms/cinder-ceph-k8s/run_tests

@@ -0,0 +1,17 @@
+#!/bin/sh -e
+# Copyright 2021 James Page
+# 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 --branch --source=src -m unittest -v "$@"
+coverage report -m

charms/cinder-ceph-k8s/src/charm.py

@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+"""Cinder Ceph Operator Charm.
+
+This charm provide Cinder <-> Ceph integration as part of an OpenStack deployment
+"""
+
+import logging
+
+
+from ops.charm import CharmBase
+from ops.framework import StoredState
+from ops.main import main
+from ops.model import ActiveStatus
+
+logger = logging.getLogger(__name__)
+
+CINDER_API_PORT = 8090
+
+
+class CinderCephOperatorCharm(CharmBase):
+    """Charm the service."""
+
+    _stored = StoredState()
+
+    def __init__(self, *args):
+        super().__init__(*args)
+
+        self.framework.observe(self.on.cinder_volume_pebble_ready,
+                               self._on_cinder_volume_pebble_ready)
+
+        self.framework.observe(self.on.config_changed,
+                               self._on_config_changed)
+
+        self._stored.set_default(amqp_ready=False)
+        self._stored.set_default(ceph_ready=False)
+
+        # TODO
+        # Register AMQP consumer + events
+
+        # TODO
+        # State modelling
+        # AMQP + Ceph -> +Volume
+
+    @property
+    def _pebble_cinder_volume_layer(self):
+        """Pebble layer for Cinder volume"""
+        return {
+            "summary": "cinder layer",
+            "description": "pebble configuration for cinder services",
+            "services": {
+                "cinder-volume": {
+                    "override": "replace",
+                    "summary": "Cinder Volume",
+                    "command": "cinder-volume --use-syslog",
+                    "startup": "enabled"
+                }
+            }
+        }
+
+    def _on_cinder_volume_pebble_ready(self, event):
+        """Define and start a workload using the Pebble API."""
+        container = event.workload
+        container.add_layer("cinder-volume", self._pebble_cinder_scheduler_layer, combine=True)
+        container.autostart()
+
+    def _on_config_changed(self, _):
+        """Just an example to show how to deal with changed configuration"""
+        # TODO
+        # Set debug logging and restart services
+        pass
+
+    def _on_amqp_ready(self, event):
+        """AMQP service ready for use"""
+        pass
+
+
+if __name__ == "__main__":
+    main(CinderCephOperatorCharm)

charms/cinder-ceph-k8s/tests/test_charm.py

@@ -0,0 +1,66 @@
+# Copyright 2021 James Page
+# 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 CharmCinderOperatorCharm
+from ops.model import ActiveStatus
+from ops.testing import Harness
+
+
+class TestCharm(unittest.TestCase):
+    def setUp(self):
+        self.harness = Harness(CharmCinderOperatorCharm)
+        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())