Template for deploying WGE Cluster

This repository contains the template for deploying a WGE cluster. Use this repository template to create a new repository and follow the instructions below to deploy a WGE cluster.

On a MacBook it is designed to use the Docker Kubernetes deployed from Docker Dashboard but can be used with any Kubernetes cluster. On Linux it will create a Kind cluster.

Prerequisites

• Docker (required for local cluster)
• Kubectl (required by various scripts)
• Flux (required by various scripts)
• vault cli (required by various scripts)
• jq (required by various scripts)
• yq (required by various scripts)
• openssl (required to generate cluster certificate)

Optional

• gitops (optional only required for GitOps CLI deployments)
• Kind (optional, only for Linux and local Kind deployments)
• aws cli (optional, only for AWS deployments)
• custerctl (optional, only for Cluster API deployments)
• clusterawsadm (optional, only for Cluster API AWS deployments)
• terraform (optional, only for AWS deployments)
• direnv (optional)
• multipass (optional, only for multipass deployments)
• htpasswd - required for generating prometheus password, optional.

Setup

Once you have created your own repository using this template, you will need to update the .envrc file with the correct values for your environment.

If you are using a MacBook start or reset the Kubernetes cluster using the Docker Dashboard. If you are using Linux the setup.sh script will create a Kind cluster.

Copy the resources/github-secrets.sh.sample file to resources/github-secrets.sh and update the values for your GitHub organization.

If you want to use OIDC to login to the WGE GUI you will need to configure your GitHub organization for OIDC and add the client keys to the resources/github-secrets.sh file. This is optional, the setup script will generate a random password for the wge-admin user and store it in the resources/wge-admin-password.txt file.

Deploy

To deploy the WGE cluster run the setup.sh script. This will create the WGE cluster and deploy the WGE GUI. If the script fails you can run it again to continue the deployment.

Once Flux has deployed the WGE GUI you can login using the wge-admin user and the password in the resources/wge-admin-password.txt file or the OIDC login.

Destroy

To destroy the WGE cluster run the reset.sh script. This will destroy the WGE cluster.