Merge branch 'main' into feat/perf-test-advanced

.github/workflows/test-multicloud.yml

@@ -0,0 +1,31 @@
+name: Test Multicloud
+
+on:
+  pull_request:
+    paths:
+      - 'test/multicloud/**'
+
+jobs:
+  multicloud-test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: opentofu/setup-opentofu@v1
+      with:
+        tofu_version: 1.8.3
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: '1.23'
+
+    - name: Install dependencies
+      run: go mod download
+      working-directory: test/multicloud/
+
+    - name: Run tests
+      run: make test
+      working-directory: test/multicloud/

test/multicloud/.gitignore

@@ -0,0 +1,6 @@
+terraform.tfvars
+.terraform
+terraform.tfstate
+*terraform.tfstate.*
+service-key.json
+*-kind-config

test/multicloud/Makefile

@@ -0,0 +1,42 @@
+PREFIX ?= retina
+STACK_NAME ?= $(PREFIX)-aks
+
+.PHONY: init plan apply quick gke aks kind destroy clean kind-kubeconfig test
+
+plan:
+	cd live/$(STACK_NAME) && \
+		tofu fmt && tofu init && tofu plan
+
+apply:
+	cd live/$(STACK_NAME) && \
+		tofu apply --auto-approve
+
+quick:
+	@make plan
+	@make apply
+
+gke: export STACK_NAME=$(PREFIX)-gke
+gke:
+	@make quick
+
+aks: export STACK_NAME=$(PREFIX)-aks
+aks:
+	@make quick
+
+kind: export STACK_NAME=$(PREFIX)-kind
+kind:
+	@make quick
+
+destroy:
+	cd live/$(STACK_NAME) && \
+		tofu destroy --auto-approve
+
+clean: destroy
+	@cd live/$(STACK_NAME) && \
+		rm -rf .terraform && rm terraform.tfstate && rm terraform.tfstate.backup
+
+kind-kubeconfig:
+	@kubectl config set-context live/$(PREFIX)-kind/mc-kind-config
+
+test:
+	@cd test && go test -v -count=1 -timeout 30m ./...

test/multicloud/README.md

@@ -0,0 +1,98 @@
+# Multi Cloud Retina
+
+This project leverages [OpenTofu](https://opentofu.org/docs/intro/) Infrastructure as Code (IaC) to create Kubernetes infrastructure on multi-cloud and deploy [microsoft/retina](https://github.com/microsoft/retina) via Helm provider.
+
+![Architecture Diagram](./diagrams/diagram.svg)
+
+## Modules available
+
+* [aks](./modules/aks/)
+* [gke](./modules/gke/)
+* [kind](./modules/kind/)
+* [retina](./modules/retina/)
+
+## Prerequisites
+
+* [OpenTofu installation guide](https://opentofu.org/docs/intro/install/)
+
+* AKS:
+
+    1. create an Azure account
+    2. [Install az](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)
+
+    To deploy an AKS cluster and install retina, create file `live/retina-aks/terraform.tfvars` with the Azure TenantID and SubscriptionID
+
+    ```sh
+    # example values
+    subscription_id     = "d6050d84-e4dd-463d-afc7-a6ab3dc33ab7"
+    tenant_id           = "ac8a4ccd-35f1-4f95-a688-f68e3d89adfc"
+    ```
+
+* GKE:
+
+    1. create a gcloud account, project and enable billing
+    2. create a service account and service account key
+    3. [Enable Kubernetes Engine API](https://console.developers.google.com/apis/api/container.googleapis.com/overview?project=mc-retina)
+    4. [Install gcloud](https://cloud.google.com/sdk/docs/install)
+
+    To deploy a GKE cluster export `GOOGLE_APPLICATION_CREDENTIALS` env variable to point to the path where your [service account key](https://cloud.google.com/iam/docs/keys-create-delete) is located.
+
+    ```sh
+    # example
+    export GOOGLE_APPLICATION_CREDENTIALS=/Users/srodi/src/retina/test/multicloud/live/retina-gke/service-key.json
+    ```
+
+* Kind:
+
+    1. Docker installed on the host machine
+
+## Quickstart
+
+The following Make targets can be used to manage each stack lifecycle.
+
+### Create
+
+Format code, initialize OpenTofu, plan and apply the stack to create infra and deploy retina
+
+* AKS:
+
+    ```sh
+    make aks
+    ```
+
+* GKE:
+
+    ```sh
+    make gke
+    ```
+
+* Kind:
+
+    ```sh
+    make kind
+    ```
+
+### Clean up
+
+To destroy the cluster specify the `STACK_NAME` and run `make clean`.
+
+```sh
+# destroy AKS and cleanup local state files
+# set a different stack as needed (i.e. retina-gke, retina-kind)
+export STACK_NAME=retina-aks
+make clean
+```
+
+### Test
+
+The test framework is levergaing Go and [Terratest](https://terratest.gruntwork.io/docs/). To run tests:
+
+```sh
+make test
+```
+
+## Providers references
+
+* [GKE resource documentation](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/container_cluster)
+* [AKS resource documentation](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/kubernetes_cluster)
+* [Kind resource documentation](https://registry.terraform.io/providers/tehcyx/kind/latest/docs/resources/cluster)