Add sunbeam-machine to monorepo

Sunbeam-machine was a miss during migration to monorepo.

Change-Id: I5ae420882258e405405a079ddb4ae3356ca776c9

charms/sunbeam-machine/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing
+
+To make contributions to this charm, you'll need a working [development setup](https://juju.is/docs/sdk/dev-setup).
+
+You can use the environments created by `tox` for development:
+
+```shell
+tox --notest -e unit
+source .tox/unit/bin/activate
+```
+
+## Testing
+
+This project uses `tox` for managing test environments. There are some pre-configured environments
+that can be used for linting and formatting code when you're preparing contributions to the charm:
+
+```shell
+tox -e fmt           # update your code according to linting rules
+tox -e lint          # code style
+tox -e unit          # unit tests
+tox -e integration   # integration tests
+tox                  # runs 'lint' and 'unit' environments
+```
+
+## Build the charm
+
+Build the charm in this git repository using:
+
+```shell
+charmcraft pack
+```
+
+<!-- You may want to include any contribution/style guidelines in this document>

charms/sunbeam-machine/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 2023 Liam
+
+   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/sunbeam-machine/README.md

@@ -0,0 +1,7 @@
+# charm-sunbeam-machine
+
+A charm used internally in a sunbeam deployment to manage machine configuration.
+
+<!-- If your charm is documented somewhere else other than Charmhub, provide a link separately. -->
+
+- See the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms.

charms/sunbeam-machine/charmcraft.yaml

@@ -0,0 +1,25 @@
+# This file configures Charmcraft.
+# See https://juju.is/docs/sdk/charmcraft-config for guidance.
+
+type: charm
+bases:
+  - build-on:
+    - name: ubuntu
+      channel: "22.04"
+    run-on:
+    - name: ubuntu
+      channel: "22.04"
+
+parts:
+  charm:
+    build-packages:
+      - git
+      - libffi-dev
+      - libssl-dev
+      - pkg-config
+      - rustc
+      - cargo
+    charm-binary-python-packages:
+      - cryptography
+      - jsonschema
+      - jinja2

charms/sunbeam-machine/config.yaml

@@ -0,0 +1,9 @@
+# This file defines charm config options, and populates the Configure tab on Charmhub.
+# If your charm does not require configuration options, delete this file entirely.
+#
+# See https://juju.is/docs/config for guidance.
+options:
+  debug:
+    default: False
+    type: boolean
+

charms/sunbeam-machine/metadata.yaml

@@ -0,0 +1,11 @@
+name: sunbeam-machine
+ 
+display-name: Sunbeam Machine
+
+summary: Manage sunbeam utilities in OpenStack deployment
+
+description: |
+  Manage machine configuration for sunbeam deployment
+
+# This charm has no peer relation by design. This charm needs to scale to
+# hundreds of units and this is limited by the peer relation.

charms/sunbeam-machine/rebuild

@@ -0,0 +1,3 @@
+# This file is used to trigger a build.
+# Change uuid to trigger a new build.
+c3b9c7c9-2bd4-4df1-a1df-89c729b34eb6

charms/sunbeam-machine/requirements.txt

@@ -0,0 +1,10 @@
+cryptography
+ops >= 1.5.0
+pyroute2
+netifaces
+jsonschema
+jinja2
+
+# This charm does not use lightkube* but ops_sunbeam requires it atm
+lightkube
+lightkube-models

charms/sunbeam-machine/src/charm.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+
+# Copyright 2024 Canonical Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""Sunbeam Machine Charm.
+
+This charm provide a place to add machine configuration and relate
+subordinates that configure machine services.
+"""
+
+import logging
+
+import ops.framework
+import ops_sunbeam.charm as sunbeam_charm
+from ops.main import (
+    main,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class SunbeamMachineCharm(sunbeam_charm.OSBaseOperatorCharm):
+    """Charm the service."""
+
+    _state = ops.framework.StoredState()
+    service_name = "sunbeam-machine"
+
+
+if __name__ == "__main__":  # pragma: nocover
+    main(SunbeamMachineCharm)

charms/sunbeam-machine/tests/unit/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2024 Canonical Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Unit tests for charm."""

charms/sunbeam-machine/tests/unit/config.yaml

@@ -0,0 +1 @@
+../../config.yaml

charms/sunbeam-machine/tests/unit/test_charm.py

@@ -0,0 +1,50 @@
+# Copyright 2024 Canonical Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Tests for Sunbeam Machine charm."""
+
+import charm
+import ops_sunbeam.test_utils as test_utils
+
+
+class _SunbeamMachineCharm(charm.SunbeamMachineCharm):
+    """Neutron test charm."""
+
+    def __init__(self, framework):
+        """Setup event logging."""
+        self.seen_events = []
+        super().__init__(framework)
+
+
+class TestCharm(test_utils.CharmTestCase):
+    """Classes for testing Sunbeam Machine charm."""
+
+    PATCHES = []
+
+    def setUp(self):
+        """Setup Sunbeam machine tests."""
+        super().setUp(charm, self.PATCHES)
+        with open("config.yaml", "r") as f:
+            config_data = f.read()
+        self.harness = test_utils.get_harness(
+            _SunbeamMachineCharm,
+            container_calls=self.container_calls,
+            charm_config=config_data,
+        )
+        self.addCleanup(self.harness.cleanup)
+
+    def test_initial(self):
+        """Bootstrap test initial."""
+        self.harness.begin_with_initial_hooks()
+        self.assertTrue(self.harness.charm.bootstrapped())

common.sh

@@ -273,6 +273,7 @@ declare -A INTERNAL_LIBS=(
 	[octavia-k8s]=${INTERNAL_NEUTRON_LIBS[@]}
 	[openstack-exporter-k8s]=${INTERNAL_KEYSTONE_LIBS[@]}
 	[openstack-hypervisor]=${INTERNAL_OPENSTACK_HYPERVISOR_LIBS[@]}
+	[sunbeam-machine]=${NULL_ARRAY[@]}
 	[ovn-central-k8s]=${INTERNAL_OVN_CENTRAL_LIBS[@]}
         [ovn-relay-k8s]=${INTERNAL_OVN_CENTRAL_LIBS[@]}
 	[placement-k8s]=${INTERNAL_KEYSTONE_LIBS[@]}
@@ -298,6 +299,7 @@ declare -A EXTERNAL_LIBS=(
         [octavia-k8s]=${EXTERNAL_OCTAVIA_LIBS[@]}
         [openstack-exporter-k8s]=${EXTERNAL_OPENSTACK_EXPORTER_LIBS[@]}
         [openstack-hypervisor]=${EXTERNAL_OPENSTACK_HYPERVISOR_LIBS[@]}
+	[sunbeam-machine]=${NULL_ARRAY[@]}
 	[ovn-central-k8s]=${EXTERNAL_OVN_CENTRAL_LIBS[@]}
         [ovn-relay-k8s]=${EXTERNAL_OVN_RELAY_LIBS[@]}
         [placement-k8s]=${EXTERNAL_AODH_LIBS[@]}
@@ -323,6 +325,7 @@ declare -A CONFIG_TEMPLATES=(
         [octavia-k8s]=${CONFIG_TEMPLATES_OCTAVIA[@]}
         [openstack-exporter-k8s]=${NULL_ARRAY[@]}
         [openstack-hypervisor]=${NULL_ARRAY[@]}
+        [sunbeam-machine]=${NULL_ARRAY[@]}
         [ovn-central-k8s]=${NULL_ARRAY[@]}
         [ovn-relay-k8s]=${NULL_ARRAY[@]}
         [placement-k8s]=${CONFIG_TEMPLATES_PLACEMENT[@]}

roles/charm-publish/defaults/main.yaml

@@ -21,3 +21,4 @@ publish_channels:
   keystone-ldap-k8s: latest/edge
   openstack-exporter-k8s: latest/edge
   openstack-hypervisor: latest/edge
+  sunbeam-machine: latest/edge

zuul.d/jobs.yaml

@@ -262,6 +262,18 @@
       - rebuild
     vars:
       charm: openstack-hypervisor
+- job:
+    name: charm-build-sunbeam-machine
+    description: Build sunbeam-machine charm
+    run: playbooks/charm/build.yaml
+    timeout: 3600
+    match-on-config-updates: false
+    files:
+      - ops-sunbeam/ops_sunbeam/*
+      - charms/sunbeam-machine/*
+      - rebuild
+    vars:
+      charm: sunbeam-machine
 
 - job:
     name: func-test-core
@@ -710,3 +722,15 @@
       - charmhub_token
     timeout: 3600
 
+- job:
+    name: publish-charm-sunbeam-machine
+    description: |
+      Publish sunbeam-machine built in gate pipeline.
+    run: playbooks/charm/publish.yaml
+    files:
+      - ops-sunbeam/ops_sunbeam/*
+      - charms/sunbeam-machine/*
+      - rebuild
+    secrets:
+      - charmhub_token
+    timeout: 3600

zuul.d/project-templates.yaml

@@ -80,6 +80,8 @@
             nodeset: ubuntu-jammy
         - charm-build-openstack-hypervisor:
             nodeset: ubuntu-jammy
+        - charm-build-sunbeam-machine:
+            nodeset: ubuntu-jammy
     gate:
       fail-fast: true
       jobs:
@@ -127,6 +129,8 @@
             nodeset: ubuntu-jammy
         - charm-build-openstack-hypervisor:
             nodeset: ubuntu-jammy
+        - charm-build-sunbeam-machine:
+            nodeset: ubuntu-jammy
 
 - project-template:
     name: charm-publish-jobs
@@ -178,3 +182,5 @@
                 nodeset: ubuntu-jammy
             - publish-charm-openstack-hypervisor:
                 nodeset: ubuntu-jammy
+            - publish-charm-sunbeam-machine:
+                nodeset: ubuntu-jammy