Add Scaleway Kapsule module

Author: pst

Makefile

@@ -62,7 +62,7 @@ validate: .init
 test: validate
 	docker exec \
 		test-container-$(GIT_SHA) \
-		entrypoint tofu apply --target module.aks_zero --target module.eks_zero --target module.gke_zero --input=false --auto-approve
+		entrypoint tofu apply --target module.aks_zero --target module.eks_zero --target module.gke_zero --target module.scw_zero --input=false --auto-approve
 	docker exec \
 		test-container-$(GIT_SHA) \
 		entrypoint tofu apply --target module.eks_zero_nginx --input=false --auto-approve
@@ -95,6 +95,7 @@ shell: .check-container
 		-e KBST_AUTH_AWS \
 		-e KBST_AUTH_AZ \
 		-e KBST_AUTH_GCLOUD \
+		-e KBST_AUTH_SCW \
 		-e HOME=/infra/tests/.user \
 		--workdir /infra/tests \
 		ghcr.io/kbst/terraform-kubestack/dev:test-$(GIT_SHA)-${DOCKER_TARGET} \

oci/Dockerfile

@@ -97,6 +97,23 @@ RUN echo "GOOGLE_CLOUD_SDK_VERSION: ${GOOGLE_CLOUD_SDK_VERSION}" \
 RUN /opt/google/bin/gcloud components install gke-gcloud-auth-plugin
 
 
+#
+#
+# Scaleway builder
+FROM builder AS scw-builder
+
+ARG TARGETARCH
+
+# https://github.com/scaleway/scaleway-cli/releases
+ARG SCALEWAY_CLI_VERSION=2.35.0
+
+RUN echo "SCALEWAY_CLI_VERSION: ${SCALEWAY_CLI_VERSION}" \
+    && curl -LO https://github.com/scaleway/scaleway-cli/releases/download/v${SCALEWAY_CLI_VERSION}/scaleway-cli_${SCALEWAY_CLI_VERSION}_linux_${TARGETARCH} \
+    && mv scaleway-cli_${SCALEWAY_CLI_VERSION}_linux_${TARGETARCH} /opt/bin/scw \
+    && chmod +x /opt/bin/scw \
+    && /opt/bin/scw version
+
+
 #
 #
 # Azure builder
@@ -231,6 +248,15 @@ COPY --from=azure-builder /opt/azure /opt/azure
 ENV PATH=$PATH:/opt/azure/bin
 
 
+#
+#
+# Scaleway variant
+FROM final-base AS scw
+
+# Scaleway
+COPY --from=scw-builder /opt/bin/scw /opt/bin/scw
+
+
 #
 #
 # Default (multi-cloud) variant
@@ -247,3 +273,6 @@ ENV PATH=$PATH:/opt/google/bin
 # Azure
 COPY --from=azure-builder /opt/azure /opt/azure
 ENV PATH=$PATH:/opt/azure/bin
+
+# Scaleway
+COPY --from=scw-builder /opt/bin/scw /opt/bin/scw

quickstart/src/configurations/multi-cloud/scw_zero_cluster.tf

@@ -0,0 +1,60 @@
+module "scw_zero" {
+  source = "github.com/kbst/terraform-kubestack//scaleway/cluster?ref={{version}}"
+
+  configuration = {
+    # apps environment
+    apps = {
+      # Set name_prefix used to generate the cluster name
+      # [name_prefix]-[workspace]-[region]
+      # e.g. name_prefix = kbst becomes: `kbst-apps-fr-par`
+      # for small orgs the name works well,
+      # for bigger orgs consider department or team names
+      name_prefix = ""
+
+      # Set the base_domain used to generate the FQDN of the cluster
+      # [cluster_name].[provider_name].[base_domain]
+      # e.g. kbst-apps-fr-par.scw.infra.example.com
+      # The domain must be registered with Scaleway Domains and DNS
+      base_domain = ""
+
+      # The Scaleway region to deploy the clusters in
+      # e.g. "fr-par", "nl-ams", "pl-waw"
+      region = ""
+
+      # Kubernetes version for the cluster
+      # Use a minor version string to allow patch upgrades, e.g. "1.32"
+      cluster_version = "1.32"
+
+      # Container Network Interface plugin
+      # Options: "cilium", "calico", "weave", "flannel", "kilo"
+      cni = "cilium"
+
+      # Whether to delete additional resources (load-balancers, block volumes,
+      # the private network if empty) created in Kubernetes when deleting the cluster.
+      # Set to true only if you want these resources cleaned up automatically on destroy.
+      delete_additional_resources = false
+
+      # Default node pool configuration
+      default_node_pool = {
+        # Commercial node type — see `scw k8s node-pool list-available-types`
+        node_type = "DEV1-M"
+
+        # Initial number of nodes in the pool
+        size = 1
+
+        # Minimum and maximum size for autoscaling
+        min_size = 1
+        max_size = 1
+
+        # Enable Scaleway's cluster autoscaler for this pool
+        autoscaling = false
+
+        # Enable automatic node replacement on failure
+        autohealing = true
+      }
+    }
+
+    # ops environment, inherits from apps
+    ops = {}
+  }
+}

quickstart/src/configurations/multi-cloud/scw_zero_providers.tf

@@ -0,0 +1,24 @@
+provider "scaleway" {
+  # region is read from SCW_DEFAULT_REGION environment variable
+  # or can be set explicitly, e.g.:
+  # region = "fr-par"
+}
+
+provider "kustomization" {
+  alias          = "scw_zero"
+  kubeconfig_raw = module.scw_zero.kubeconfig
+}
+
+locals {
+  scw_zero_kubeconfig = yamldecode(module.scw_zero.kubeconfig)
+}
+
+provider "kubernetes" {
+  alias = "scw_zero"
+
+  host  = local.scw_zero_kubeconfig["clusters"][0]["cluster"]["server"]
+  token = local.scw_zero_kubeconfig["users"][0]["user"]["token"]
+  cluster_ca_certificate = base64decode(
+    local.scw_zero_kubeconfig["clusters"][0]["cluster"]["certificate-authority-data"]
+  )
+}

quickstart/src/configurations/multi-cloud/versions.tf

@@ -7,6 +7,10 @@ terraform {
     kustomization = {
       source = "kbst/kustomization"
     }
+
+    scaleway = {
+      source = "scaleway/scaleway"
+    }
   }
 
   required_version = ">= 0.15"

quickstart/src/configurations/scw/.gitignore

@@ -0,0 +1,9 @@
+#  Local .terraform directories
+**/.terraform/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# .user home directory
+.user/

quickstart/src/configurations/scw/Dockerfile

@@ -0,0 +1 @@
+FROM {{image_name}}:{{image_tag}}-scw

quickstart/src/configurations/scw/Dockerfile.loc

@@ -0,0 +1,10 @@
+FROM {{image_name}}:{{image_tag}}-kind
+
+ARG UID
+ARG GID
+
+RUN mkdir -p /infra/terraform.tfstate.d &&\
+    chown ${UID}:${GID} -R /infra
+
+COPY manifests /infra/manifests
+COPY *.tf *.tfvars /infra/

quickstart/src/configurations/scw/README.md

@@ -0,0 +1,134 @@
+# Welcome to Kubestack
+
+This repository uses [Kubestack][1]. Kubestack is the open source GitOps framework for teams that want to automate infrastructure, not reinvent automation.
+
+- Cluster infrastructure and cluster services are defined using Terraform modules.
+- Popular cluster services are available from the Terraform module [catalog][2].
+- Both cluster and cluster service modules follow the Kubestack [inheritance model][3] to prevent configuration drift between environments.
+- All changes follow the same four-step process.
+
+Full [framework documentation][4] is available online.
+
+## Making changes
+
+To make changes to the Kubernetes cluster(s), supporting infrastructure or the Kubernetes services defined in this repository follow the Kubestack [GitOps process][5]. The GitOps process ensures that changes are safely applied by first reviewing the proposed changes, then validating the changes against the _ops_ environment and finally promoting the changes to be applied against the _apps_ environment by setting a tag.
+
+To accelerate the developer workflow an auto-updating [development environment][6] can be run on localhost using the `kbst local apply` command.
+
+1. Change
+
+   Make changes to the configuration in a new branch. Commit the changed configuration and push your branch. The pipeline runs `terraform plan` against the _ops_ workspace.
+
+   ```shell
+   # checkout a new branch from main
+   git checkout -b examplechange main
+
+   # make your changes
+
+   # commit your changes
+   git commit  # write a meaningful commit message
+
+   # push your changes
+   git push origin examplechange
+   ```
+
+1. Review
+
+   Request a peer review of your changes. Team members review the changes and the Terraform plan. If reviewers require changes, make additional commits in the branch.
+
+   ```shell
+   # make sure you're in the correct branch
+   git checkout examplechange
+
+   # make changes required by the review
+
+   # commit and push the required changes
+   git commit  # write a meaningful commit message
+   git push origin examplechange
+   ```
+
+1. Merge
+
+   If approved, merge your changes to main, to apply them against the _ops_ environment. After applying to _ops_ was successful, the pipeline runs Terraform plan against the _apps_ environment.
+
+   ```shell
+   # you can merge on the commandline
+   # or by merging a pull request
+   git checkout main
+   git merge examplechange
+   git push origin main
+   ```
+
+1. Promote
+
+   Review the previous _apps_ environment plan and tag the merge commit to promote the same changes to the _apps_ environment.
+
+   ```shell
+   # make sure you're on the correct commit
+   git checkout main
+   git pull
+   git log -1
+
+   # if correct, tag the current commit
+   # any tag prefixed with `apps-deploy-`
+   # will trigger the pipeline
+   git tag apps-deploy-$(date -I)-0
+
+   # in case of multiple deploys on the same day,
+   # increase the counter
+   # e.g. git tag apps-deploy-2020-05-14-1
+   ```
+
+## Manual operations
+
+In case of the automation being unavailable, upgrades requiring manual steps or in disaster recovery scenarios run Terraform and the cloud CLI locally. Kubestack provides container images bundling all dependencies to use for both automated and manual operations.
+
+1. Exec into container
+
+   ```shell
+   # Build the container image
+   docker build -t kubestack .
+
+   # Exec into the container image
+   # add docker socket mount for local dev
+   # -v /var/run/docker.sock:/var/run/docker.sock
+   docker run --rm -ti \
+      -v `pwd`:/infra \
+      kubestack
+   ```
+
+1. Authenticate providers
+
+   Credentials are cached inside the `.user` directory. The directory is excluded from Git by the default `.gitignore`.
+
+   ```shell
+   # for Scaleway
+   scw init
+   ```
+
+1. Select desired environment
+
+   ```shell
+   # for ops
+   terraform workspace select ops
+
+   # or for apps
+   terraform workspace select apps
+   ```
+
+1. Run Terraform commands
+
+   ```shell
+   # run terraform init
+   terraform init
+
+   # run, e.g. terraform plan
+   terraform plan
+   ```
+
+[1]: https://www.kubestack.com
+[2]: https://www.kubestack.com/catalog
+[3]: https://www.kubestack.com/framework/documentation/inheritance-model
+[4]: https://www.kubestack.com/framework/documentation
+[5]: https://www.kubestack.com/framework/documentation/gitops-process
+[6]: https://www.kubestack.com/framework/documentation/tutorial-develop-locally#provision-local-clusters

quickstart/src/configurations/scw/scw_zero_cluster.tf

@@ -0,0 +1,70 @@
+module "scw_zero" {
+  source = "github.com/kbst/terraform-kubestack//scaleway/cluster?ref={{version}}"
+
+  configuration = {
+    # apps environment
+    apps = {
+      # Set name_prefix used to generate the cluster name
+      # [name_prefix]-[workspace]-[region]
+      # e.g. name_prefix = kbst becomes: `kbst-apps-fr-par`
+      # for small orgs the name works well,
+      # for bigger orgs consider department or team names
+      name_prefix = ""
+
+      # Set the base_domain used to generate the FQDN of the cluster
+      # [cluster_name].[provider_name].[base_domain]
+      # e.g. kbst-apps-fr-par.scw.infra.example.com
+      # The domain must be registered with Scaleway Domains and DNS
+      base_domain = ""
+
+      # The Scaleway region to deploy the clusters in
+      # e.g. "fr-par", "nl-ams", "pl-waw"
+      region = ""
+
+      # Kubernetes version for the cluster
+      # Use a minor version string to allow patch upgrades, e.g. "1.32"
+      cluster_version = "1.32"
+
+      # Container Network Interface plugin
+      # Options: "cilium", "calico", "weave", "flannel", "kilo"
+      cni = "cilium"
+
+      # Whether to delete additional resources (load-balancers, block volumes,
+      # the private network if empty) created in Kubernetes when deleting the cluster.
+      # Set to true only if you want these resources cleaned up automatically on destroy.
+      delete_additional_resources = false
+
+      # Default node pool configuration
+      default_node_pool = {
+        # Commercial node type — must be available in every zone listed below.
+        # Run `scw k8s node-pool list-available-types` to list types available per zone.
+        # PRO2-XXS (2 vCPUs, 8 GiB) is available in all fr-par, nl-ams and pl-waw zones.
+        node_type = "PRO2-XXS"
+
+        # Availability zones to distribute the default node pool across.
+        # One pool is created per zone. Must be explicitly specified.
+        # The node_type above must be available in every zone listed here.
+        # e.g. fr-par: ["fr-par-1", "fr-par-2", "fr-par-3"]
+        # e.g. nl-ams: ["nl-ams-1", "nl-ams-2", "nl-ams-3"]
+        # e.g. pl-waw: ["pl-waw-1", "pl-waw-2", "pl-waw-3"]
+        zones = ["fr-par-1", "fr-par-2", "fr-par-3"]
+
+        # Initial number of nodes per zone
+        size = 1
+
+        # Minimum and maximum nodes per zone for autoscaling
+        min_size = 1
+        max_size = 2
+
+        # Enable Scaleway's cluster autoscaler for this pool
+        autoscaling = true
+
+        # Enable automatic node replacement on failure
+        autohealing = true
+      }
+    }
+
+    # ops environment, inherits from apps
+    ops = {}
+  }
+}