Files
trailofbits-buttercup/deployment/env.template
T
Riccardo Schirone fbe5b98dc1 deployment: make it easy to work in minikube (#347)
* deployment: add a minikube environment

* deployment: allow to use minikube for local dev

* deployment: make minikube use local images
2025-04-07 10:25:21 +02:00

65 lines
3.1 KiB
Plaintext

# Reference a values file for kubernetes deployment. This should be a template
# file, filled by crs-architecture.sh with the correct variables.
# See values-minikube.template, values-aks.template, values-prod.template
export BUTTERCUP_K8S_VALUES_TEMPLATE="k8s/values-minikube.template"
export AZURE_ENABLED=false # or true
# These are terraform variables, necessary only for actual deployment in AKS
# See README.md for instructions on how to set them up.
export TF_VAR_ARM_CLIENT_ID="<your-client-id>"
export TF_VAR_ARM_CLIENT_SECRET="<your-client-secret>"
export TF_VAR_ARM_TENANT_ID="<your-tenant-id>"
export TF_VAR_ARM_SUBSCRIPTION_ID="<your-sub-id>"
export TF_VAR_USR_NODE_COUNT=3
export TF_VAR_RESOURCE_GROUP_NAME_PREFIX="<resource-prefix>"
# TailScale variables, necessary only for production/staging deployments
export TAILSCALE_ENABLED=false # or true
export TS_CLIENT_ID="<your-tailscale-oauth-client-id>"
export TS_CLIENT_SECRET="<your-tailscale-oauth-client-secret>"
export TS_OP_TAG="<your-tailscale-operator-tag>"
# Competition API settings, used to properly connect to the right endpoint and
# with the right authentication. If COMPETITION_API_ENABLED is true, a test API
# will be deployed and configured according to the variables.
# SCANTRON_GITHUB_PAT is a GitHub PAT with at least package:read and repo:write
# permissions.
export COMPETITION_API_ENABLED=true # or false
export COMPETITION_API_KEY_ID="<your-competitionapi-key-id>" # 11111111-1111-1111-1111-111111111111
export COMPETITION_API_KEY_TOKEN="<your-competition-api-key-token>" # secret
# export COMPETITION_API_URL="<competition-api-url>"
export SCANTRON_GITHUB_PAT="<gh-pat-with-repo-read+packages-read>"
# CRS settings
export CRS_KEY_ID="<your-crs-key-id>" # 515cc8a0-3019-4c9f-8c1c-72d0b54ae561
export CRS_KEY_TOKEN="<your-crs-key-token>" # VGuAC8axfOnFXKBB7irpNDOKcDjOlnyB
export CRS_KEY_TOKEN_HASH='<argon2-hash-for-crs-key-token>' # $argon2id$v=19$m=65536,t=3,p=4$Dg1v6NPGTyXPoOPF4ozD5A$wa/85ttk17bBsIASSwdR/uGz5UKN/bZuu4wu+JIy1iA
# export CRS_URL="<your-crs-api-url>"
# export CRS_API_HOSTNAME="<your-crs-api-hostname>"
# GitHub Container Registry auth, base64 encoded
# echo "USERNAME:$GHCR_PAT" | base64
# The PAT should have at least package:read permissions
export GHCR_AUTH="<your-ghcr-base64-auth>"
# LiteLLM/LLMs settings
export LITELLM_MASTER_KEY="<your-random-litellm-key>" # Generate with: openssl rand -hex 16
export AZURE_API_BASE="<your-azure-openai-base-url>"
export AZURE_API_KEY="<your-azure-openai-api-key>"
export OPENAI_API_KEY="<your-openai-api-key>"
export ANTHROPIC_API_KEY="<your-anthropic-api-key>"
# LangFuse settings, instructing LLM-applications to log their LLM traces
# export LANGFUSE_HOST="<your-langfuse-host-url>"
# export LANGFUSE_PUBLIC_KEY="<your-langfuse-public-key>"
# export LANGFUSE_SECRET_KEY="<your-langfuse-secret-key>"
# OpenTelemetry endpoint settings (e.g. SigNoz)
# export OTEL_ENDPOINT="<your-otel-endpoint>"
# export OTEL_TOKEN="<your-otel-http-token>"
# Docker Hub credentials for doing logged requests while getting Container
# Images from DockerHub.
export DOCKER_USERNAME="<your-docker-username>"
export DOCKER_PAT="<your-docker-pat>"