Initial implementation using kustomize and envsubst

.yamllint.yml

@@ -22,3 +22,4 @@ ignore: |
   manifests/
   vendor/
   compiled/
+  tests/golden/**

Makefile

@@ -81,4 +81,4 @@ $(test_instances):
 
 .PHONY: clean
 clean: ## Clean the project
-	rm -rf .cache compiled dependencies vendor helmcharts jsonnetfile*.json || true
+	rm -rf .cache compiled dependencies vendor helmcharts manifests jsonnetfile*.json || true

class/capi-provider-cloudscale.yml

@@ -8,4 +8,23 @@ parameters:
       - input_paths:
           - ${_base_directory}/component/main.jsonnet
         input_type: jsonnet
-        output_path: capi-provider-cloudscale/
+        output_path: ${_base_directory}/manifests/capi-provider-cloudscale/
+      - input_type: external
+        output_path: .
+        input_paths:
+          - ${_kustomize_wrapper}
+        env_vars:
+          INPUT_DIR: ${_base_directory}/manifests/capi-provider-cloudscale/
+        args:
+          - ${_base_directory}/manifests/capi-provider-cloudscale-rendered/
+      - input_type: external
+        output_path: .
+        input_paths:
+          - ${_base_directory}/scripts/envsubst-dir
+        # map env vars from parameters as needed
+        env_vars:
+          ENVSUBST_VERSION: v1.4.3
+          CLOUDSCALE_API_TOKEN: ${capi_provider_cloudscale:variables:cloudscale_api_token}
+        args:
+          - ${_base_directory}/manifests/capi-provider-cloudscale-rendered
+          - \${compiled_target_dir}/capi-provider-cloudscale/10_kustomize

class/defaults.yml

@@ -2,4 +2,18 @@ parameters:
   capi_provider_cloudscale:
     =_metadata:
       multi_tenant: true
-    namespace: syn-capi-provider-cloudscale
+    # The component assumes that this namespace already exists via dependency `component-capi-core`
+    namespace: syn-cluster-api
+
+    images:
+      capi-provider-cloudscale:
+        registry: quay.io
+        image: cloudscalech/cluster-api-cloudscale-controller
+        tag: v1.0.1
+
+    # An object with variables that the generated manifests will be templated with.
+    # They should be specified in the format:
+    # variables:
+    #   my_variable: bar
+    variables:
+      cloudscale_api_token: ""

component/main.jsonnet

@@ -1,10 +1,46 @@
 // main template for capi-provider-cloudscale
+local com = import 'lib/commodore.libjsonnet';
 local kap = import 'lib/kapitan.libjsonnet';
 local kube = import 'lib/kube.libjsonnet';
 local inv = kap.inventory();
 // The hiera parameters for the component
 local params = inv.parameters.capi_provider_cloudscale;
 
-// Define outputs below
-{
+assert std.member(inv.applications, 'capi-core') : 'Application capi-core is not available';
+assert std.length(params.variables.cloudscale_api_token) > 0 : 'capi-provider-cloudscale:variables:cloudscale_api_token must be set';
+
+local manifest_path = 'config/default';
+
+com.Kustomization(
+  'https://github.com/cloudscale-ch/cluster-api-provider-cloudscale/' + manifest_path,
+  params.images['capi-provider-cloudscale'].tag,
+  {
+    'quay.io/cloudscalech/capcs-staging': {
+      local image = params.images['capi-provider-cloudscale'],
+      newTag: image.tag,
+      newName: '%(registry)s/%(image)s' % image,
+    },
+  },
+  {
+    namespace: params.namespace,
+    labels+: [
+      {
+        pairs: {
+          'app.kubernetes.io/managed-by': 'commodore',
+        },
+      },
+    ],
+    patchesStrategicMerge: [ 'rm-namespace.yaml' ],
+  },
+) {
+  'rm-namespace': [
+    {
+      '$patch': 'delete',
+      apiVersion: 'v1',
+      kind: 'Namespace',
+      metadata: {
+        name: 'capcs-system',
+      },
+    },
+  ],
 }

scripts/envsubst-dir

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+basedir=$(dirname "$0")/../dependencies
+version="${ENVSUBST_VERSION:-v1.4.3}"
+
+src="$1"
+dst="$2"
+
+ensure_envsubst () {
+  set -eu
+
+  local dir="$1"
+  # Version with leading `v`.
+  local version="$2"
+
+  local arch
+  arch=$(uname -m)
+  case $arch in
+    aarch64|arm64) arch="arm64";;
+    x86_64|amd64) arch="x86_64";;
+    *)
+      >&2 echo "Unsupported arch: $arch"
+      exit 5
+    ::
+  esac
+
+  local os
+  os=$(uname -s)
+  if [[ "$os" != "Linux" && "$os" != "Darwin" ]]; then
+    >&2 echo "Unsupported os: $os"
+    exit 5
+  fi
+
+  if [ ! -x "${dir}/envsubst-${version}-${os}-${arch}" ]; then
+    download_envsubst "${dir}" "${version}" "${os}" "${arch}"
+  else
+    >&2 echo "envsubst-${version}-${os}-${arch} already installed"
+  fi
+
+  echo "${dir}/envsubst-${version}-${os}-${arch}"
+}
+
+download_envsubst () {
+  set -eu
+
+  local dir="$1"
+  local version="$2"
+  local os="$3"
+  local arch="$4"
+
+  local url="https://github.com/a8m/envsubst/releases/download/${version}/envsubst-${os}-${arch}"
+
+  >&2 echo "Downloading envsubst-${version}-${os}-${arch} from ${url}"
+
+  curl -fsSLo "${dir}/envsubst-${version}-${os}-${arch}" "${url}"
+  chmod +x "${dir}/envsubst-${version}-${os}-${arch}"
+
+  >&2 echo "envsubst-${version}-${os}-${arch} successfully installed"
+}
+
+envsubst="$(ensure_envsubst "${basedir}" "${version}")"
+
+mkdir -p "$dst"
+
+find "$src" -type f -name '*.yaml' -print0 |
+while IFS= read -r -d '' file; do
+    relative="${file#$src/}"
+    output="$dst/$relative"
+
+    mkdir -p "$(dirname "$output")"
+
+    "$envsubst" \
+        -no-unset \
+        -i "$file" \
+        -o "$output"
+done

tests/defaults.yml

@@ -1,3 +1,9 @@
 # Overwrite parameters here
 
-# parameters: {...}
+applications:
+  - capi-core
+
+parameters:
+  capi_provider_cloudscale:
+    variables:
+      cloudscale_api_token: "MY_CLOUDSCALE_API_TOKEN"

tests/golden/defaults/capi-provider-cloudscale/capi-provider-cloudscale/10_kustomize/admissionregistration.k8s.io_v1_mutatingwebhookconfiguration_capcs-mutating-webhook-configuration.yaml

@@ -0,0 +1,90 @@
+apiVersion: admissionregistration.k8s.io/v1
+kind: MutatingWebhookConfiguration
+metadata:
+  annotations:
+    cert-manager.io/inject-ca-from: capcs-system/capcs-serving-cert
+  labels:
+    app.kubernetes.io/managed-by: commodore
+    cluster.x-k8s.io/provider: infrastructure-cloudscale-ch-cloudscale
+  name: capcs-mutating-webhook-configuration
+webhooks:
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: capcs-webhook-service
+      namespace: syn-cluster-api
+      path: /mutate-infrastructure-cluster-x-k8s-io-v1beta2-cloudscalecluster
+  failurePolicy: Fail
+  name: mcloudscalecluster-v1beta2.kb.io
+  rules:
+  - apiGroups:
+    - infrastructure.cluster.x-k8s.io
+    apiVersions:
+    - v1beta2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - cloudscaleclusters
+  sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: capcs-webhook-service
+      namespace: syn-cluster-api
+      path: /mutate-infrastructure-cluster-x-k8s-io-v1beta2-cloudscaleclustertemplate
+  failurePolicy: Fail
+  name: mcloudscaleclustertemplate-v1beta2.kb.io
+  rules:
+  - apiGroups:
+    - infrastructure.cluster.x-k8s.io
+    apiVersions:
+    - v1beta2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - cloudscaleclustertemplates
+  sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: capcs-webhook-service
+      namespace: syn-cluster-api
+      path: /mutate-infrastructure-cluster-x-k8s-io-v1beta2-cloudscalemachine
+  failurePolicy: Fail
+  name: mcloudscalemachine-v1beta2.kb.io
+  rules:
+  - apiGroups:
+    - infrastructure.cluster.x-k8s.io
+    apiVersions:
+    - v1beta2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - cloudscalemachines
+  sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: capcs-webhook-service
+      namespace: syn-cluster-api
+      path: /mutate-infrastructure-cluster-x-k8s-io-v1beta2-cloudscalemachinetemplate
+  failurePolicy: Fail
+  name: mcloudscalemachinetemplate-v1beta2.kb.io
+  rules:
+  - apiGroups:
+    - infrastructure.cluster.x-k8s.io
+    apiVersions:
+    - v1beta2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - cloudscalemachinetemplates
+  sideEffects: None

tests/golden/defaults/capi-provider-cloudscale/capi-provider-cloudscale/10_kustomize/admissionregistration.k8s.io_v1_validatingwebhookconfiguration_capcs-validating-webhook-configuration.yaml

@@ -0,0 +1,90 @@
+apiVersion: admissionregistration.k8s.io/v1
+kind: ValidatingWebhookConfiguration
+metadata:
+  annotations:
+    cert-manager.io/inject-ca-from: capcs-system/capcs-serving-cert
+  labels:
+    app.kubernetes.io/managed-by: commodore
+    cluster.x-k8s.io/provider: infrastructure-cloudscale-ch-cloudscale
+  name: capcs-validating-webhook-configuration
+webhooks:
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: capcs-webhook-service
+      namespace: syn-cluster-api
+      path: /validate-infrastructure-cluster-x-k8s-io-v1beta2-cloudscalecluster
+  failurePolicy: Fail
+  name: vcloudscalecluster-v1beta2.kb.io
+  rules:
+  - apiGroups:
+    - infrastructure.cluster.x-k8s.io
+    apiVersions:
+    - v1beta2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - cloudscaleclusters
+  sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: capcs-webhook-service
+      namespace: syn-cluster-api
+      path: /validate-infrastructure-cluster-x-k8s-io-v1beta2-cloudscaleclustertemplate
+  failurePolicy: Fail
+  name: vcloudscaleclustertemplate-v1beta2.kb.io
+  rules:
+  - apiGroups:
+    - infrastructure.cluster.x-k8s.io
+    apiVersions:
+    - v1beta2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - cloudscaleclustertemplates
+  sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: capcs-webhook-service
+      namespace: syn-cluster-api
+      path: /validate-infrastructure-cluster-x-k8s-io-v1beta2-cloudscalemachine
+  failurePolicy: Fail
+  name: vcloudscalemachine-v1beta2.kb.io
+  rules:
+  - apiGroups:
+    - infrastructure.cluster.x-k8s.io
+    apiVersions:
+    - v1beta2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - cloudscalemachines
+  sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: capcs-webhook-service
+      namespace: syn-cluster-api
+      path: /validate-infrastructure-cluster-x-k8s-io-v1beta2-cloudscalemachinetemplate
+  failurePolicy: Fail
+  name: vcloudscalemachinetemplate-v1beta2.kb.io
+  rules:
+  - apiGroups:
+    - infrastructure.cluster.x-k8s.io
+    apiVersions:
+    - v1beta2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - cloudscalemachinetemplates
+  sideEffects: None