From 52464392ef9e29860094113066c9576653c8f302 Mon Sep 17 00:00:00 2001 From: Jadon Naas Date: Tue, 24 Sep 2024 11:29:31 -0400 Subject: [PATCH 1/2] Basic rock configuration for HashiCorp Consul OpenStack Masakari requires HashiCorp Consul. This change adds a rockcraft.yaml configuration for building a Consul rock from the consul-client snap I registered. The Consul rock is for running Consul in server mode in Kubernetes. The consult-client snap will provide Consul for running in client mode on compute hypervisor nodes. Signed-off-by: Guillaume Boutry --- rocks/consul/LICENSE | 191 ++++++++++++++++++++++++++++++++++++ rocks/consul/README.md | 32 ++++++ rocks/consul/rockcraft.yaml | 51 ++++++++++ 3 files changed, 274 insertions(+) create mode 100644 rocks/consul/LICENSE create mode 100644 rocks/consul/README.md create mode 100644 rocks/consul/rockcraft.yaml diff --git a/rocks/consul/LICENSE b/rocks/consul/LICENSE new file mode 100644 index 0000000..1a8a630 --- /dev/null +++ b/rocks/consul/LICENSE @@ -0,0 +1,191 @@ + + Apache License + Version 2.0, January 2004 + https://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 + + Copyright 2023 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 + + https://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. diff --git a/rocks/consul/README.md b/rocks/consul/README.md new file mode 100644 index 0000000..fb7a57f --- /dev/null +++ b/rocks/consul/README.md @@ -0,0 +1,32 @@ +# consul ROCK + +This is a ROCK OCI image for consul. + +More information is coming. + +For now, if you want to play with it: + +```bash +> sudo snap install rockcraft --edge --classic +> rockcraft pack +``` + +Now that you have created the ROCK, you can import it into +your local docker repository. Using skopeo is a good idea as +it will help ensure that all layers of the image are imported +into docker (this is just the top layer). + +```bash +> skopeo --insecure-policy copy oci-archive:consul_v1.19.2_amd64.rock docker-daemon:consul:v1.19.2 +``` + +If you are interested in giving it a go in Microk8s, you can +export the image from your docker registry and then into the +microk8s registry: + +```bash +> docker save consul:v1.19.2 > ./consul_v1.19.2.tar +> microk8s ctr image import ./consul_v1.19.2.tar +# Try with sunbeam +> juju attach-resource consul consul-image=consul:v1.19.2 +``` diff --git a/rocks/consul/rockcraft.yaml b/rocks/consul/rockcraft.yaml new file mode 100644 index 0000000..5978c4b --- /dev/null +++ b/rocks/consul/rockcraft.yaml @@ -0,0 +1,51 @@ +name: consul +summary: Hashicorp Consul +license: Apache-2.0 +description: | + Ubuntu distribution of Hashicorp Consul +version: 'v1.19.2' + +# renovate: base: ubuntu:22.04@sha256:1b8d8ff4777f36f19bfe73ee4df61e3a0b789caeff29caa019539ec7c9a57f95 +base: ubuntu@22.04 +platforms: + amd64: + +package-repositories: + - type: apt + cloud: caracal + priority: always + +services: + consul: + override: replace + command: consul + +parts: + consul-user: + plugin: nil + overlay-script: | + groupadd --root $CRAFT_OVERLAY --gid 5996 --system consul + useradd \ + --gid 5996 \ + --uid 5996 \ + --no-create-home \ + --home /var/lib/consul \ + --root $CRAFT_OVERLAY \ + --system \ + --shell /bin/false \ + consul + override-prime: | + craftctl default + + # Give permission and create the required directories + mkdir -p $CRAFT_PRIME/var/lib/consul + chown -R 5996:5996 $CRAFT_PRIME/var/lib/consul + + snap-consul-client: # replace with consul snap once it is available + after: [consul-user] + plugin: nil + stage-snaps: + - consul-client/latest/edge + override-prime: | + mkdir -p $CRAFT_PRIME/usr/local/bin + cp /root/parts/$CRAFT_PART_NAME/install/consul $CRAFT_PRIME/usr/local/bin/consul \ No newline at end of file From aa4483b5a1f8492e434953b06721d40724182b6b Mon Sep 17 00:00:00 2001 From: Guillaume Boutry Date: Wed, 2 Oct 2024 10:29:02 +0200 Subject: [PATCH 2/2] Simplify rock, make it bare based The rock is based on a single go binary, a whole ubuntu distribution is unnecessary. Still, include coreutils_bins and bash_bins to simplify debugging at run time. Signed-off-by: Guillaume Boutry --- rocks/consul/README.md | 8 +++--- rocks/consul/rockcraft.yaml | 49 ++++++++++++++++--------------------- 2 files changed, 25 insertions(+), 32 deletions(-) diff --git a/rocks/consul/README.md b/rocks/consul/README.md index fb7a57f..7df81b0 100644 --- a/rocks/consul/README.md +++ b/rocks/consul/README.md @@ -17,7 +17,7 @@ it will help ensure that all layers of the image are imported into docker (this is just the top layer). ```bash -> skopeo --insecure-policy copy oci-archive:consul_v1.19.2_amd64.rock docker-daemon:consul:v1.19.2 +> skopeo --insecure-policy copy oci-archive:consul_1.19.2_amd64.rock docker-daemon:consul:1.19.2 ``` If you are interested in giving it a go in Microk8s, you can @@ -25,8 +25,8 @@ export the image from your docker registry and then into the microk8s registry: ```bash -> docker save consul:v1.19.2 > ./consul_v1.19.2.tar -> microk8s ctr image import ./consul_v1.19.2.tar +> docker save consul:1.19.2 > ./consul_1.19.2.tar +> microk8s ctr image import ./consul_1.19.2.tar # Try with sunbeam -> juju attach-resource consul consul-image=consul:v1.19.2 +> juju attach-resource consul consul-image=consul:1.19.2 ``` diff --git a/rocks/consul/rockcraft.yaml b/rocks/consul/rockcraft.yaml index 5978c4b..adf2f83 100644 --- a/rocks/consul/rockcraft.yaml +++ b/rocks/consul/rockcraft.yaml @@ -3,49 +3,42 @@ summary: Hashicorp Consul license: Apache-2.0 description: | Ubuntu distribution of Hashicorp Consul -version: 'v1.19.2' - -# renovate: base: ubuntu:22.04@sha256:1b8d8ff4777f36f19bfe73ee4df61e3a0b789caeff29caa019539ec7c9a57f95 -base: ubuntu@22.04 +version: "1.19.2" +base: bare +build-base: ubuntu@24.04 platforms: amd64: -package-repositories: - - type: apt - cloud: caracal - priority: always +run-user: _daemon_ services: consul: override: replace - command: consul + command: bin/consul agent + user: consul + group: consul parts: consul-user: plugin: nil - overlay-script: | - groupadd --root $CRAFT_OVERLAY --gid 5996 --system consul - useradd \ - --gid 5996 \ - --uid 5996 \ - --no-create-home \ - --home /var/lib/consul \ - --root $CRAFT_OVERLAY \ - --system \ - --shell /bin/false \ - consul override-prime: | craftctl default - # Give permission and create the required directories - mkdir -p $CRAFT_PRIME/var/lib/consul - chown -R 5996:5996 $CRAFT_PRIME/var/lib/consul + mkdir -p $CRAFT_PRIME/etc || true + echo "consul:x:5996:" >> $CRAFT_PRIME/etc/group + echo "consul:x:5996:5996::/var/lib/consul:/usr/bin/false" >> $CRAFT_PRIME/etc/passwd + folders=(var/lib/consul etc/consul.d) + for folder in "${folders[@]}"; do + mkdir -p $CRAFT_PRIME/$folder || true + chown -R 5996:5996 $CRAFT_PRIME/$folder + done - snap-consul-client: # replace with consul snap once it is available + snap-consul-client: after: [consul-user] + stage-packages: + # following are just for debug purposes + - bash_bins + - coreutils_bins plugin: nil stage-snaps: - - consul-client/latest/edge - override-prime: | - mkdir -p $CRAFT_PRIME/usr/local/bin - cp /root/parts/$CRAFT_PART_NAME/install/consul $CRAFT_PRIME/usr/local/bin/consul \ No newline at end of file + - consul-client/latest/edge