config.sh.example

# muster config (copy to config.sh and edit). Sourced by the `muster`
# entrypoint before flags, so any flag overrides the value set here. This is
# plain bash: every line is `KEY=value`. Do not commit config.sh (gitignored).

# --- substrate ---------------------------------------------------------------
# PROVIDER: k3d | docker | existing (existing deferred). --provider overrides.
#   k3d    helm chart on k3s-in-docker (full cluster; needs k3d + helm)
#   docker standalone rancher/rancher container (no helm/k8s for community
#          channels; staging/prime still need helm to resolve the image tag)
PROVIDER="k3d"

# INSTANCE: logical name; drives kubeconfig/handoff/port offsets. --instance.
INSTANCE="e2e"

# --- Rancher version matrix --------------------------------------------------
# Two axes, ported from the ansible resolve-helm-version task:
#
# RANCHER_REPO selects the release channel (chart URL + image registry):
#   rancher-com-alpha Docker Hub alpha (head -> master image)    [default]
#   rancher-com-rc    Docker Hub RC (head -> master image)
#   rancher-latest    optimus RC staging (stgregistry image)
#   rancher-alpha     optimus alpha staging (stgregistry image)
#   rancher-prime-ga  registry.rancher.com GA prime; anonymously pullable
#   rancher-prime     SUSE prime registry; GATED, needs pull creds set up
#   rancher-community Docker Hub stable
# Community Docker Hub is the default (no creds, real moving master via head);
# the optimus alpha/rc staging channels and prime are opt-in.
#
# Whether a build reports itself as Prime, which gates Prime-only UI extensions,
# is a property of the image and not of the channel. Run
# `muster up --dry-run` to read it off the image a given set of flags resolves
# to. rancher-prime-ga needs no credentials.
RANCHER_REPO="rancher-com-alpha"

# RANCHER_IMAGE_TAG: "head" (newest devel chart in the channel) or a version
# pin like 2.13 / 2.13.4 / 2.13.4-rc1. For staging channels the resolved chart
# version becomes the image tag (v<chart_version>); community channels use the
# tag as-is from Docker Hub. --version overrides.
RANCHER_IMAGE_TAG="head"

# RANCHER_PASSWORD: bootstrap password handed to the framework's setup spec.
# muster does NOT perform first-login; the consumer owns that.
RANCHER_PASSWORD="password1234"

# CERT_MANAGER_VERSION: cert-manager chart version (upstream parity).
CERT_MANAGER_VERSION="v1.16.2"

# K3S_IMAGE: k3d node image (k3d provider only). Left unset, it is taken from
# the dashboard team's branches-metadata.json for the release line implied by
# RANCHER_IMAGE_TAG, so the UI is tested on the Kubernetes version its suite
# was written against. Set MUSTER_IGNORE_BRANCH_METADATA=1 to opt out.
K3S_IMAGE="rancher/k3s:v1.33.1-k3s1"

# --- external access (optional) ----------------------------------------------
# EXTERNAL=true exposes Rancher through a cloudflared quick tunnel so an
# out-of-cluster node can register (provisioning tests). --external overrides.
EXTERNAL="false"

# EXTERNAL_HOSTNAME: bring-your-own public host; skips the auto quick tunnel.
EXTERNAL_HOSTNAME=""

# --- existing provider -------------------------------------------------------
# Required when PROVIDER=existing: the caller's cluster + Rancher host.
# KUBECONFIG=""
# RANCHER_HOST=""

# --- handoff -----------------------------------------------------------------
# OUT: env | cypress | json. The format written for the consuming framework.
OUT="env"