Compare commits

...

3 Commits

Author SHA1 Message Date
Paul Payne
9f5057dff8 feat(validation): add validation scripts for Wild Cloud app packages 2026-07-02 20:55:53 +00:00
Paul Payne
d9f10716b0 fix(pretix): increase memory limit to 6Gi; eventyay nginx sidecar; crowdsec middleware
pretix/standalone runs gunicorn + celery + celery-beat in one container
and OOMKilled at 4Gi. Increased limit to 6Gi, request to 512Mi.

eventyay: add nginx sidecar to serve static files, update health probes
to check a static asset at port 8080, add create-superuser script,
register script in manifest.

crowdsec: middleware fix (previously uncommitted).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-22 04:20:40 +00:00
Paul Payne
74570413fc fix(karrot): fix nginx DNS resolver for Kubernetes and add README
The karrot-frontend nginx template hardcodes Docker's DNS resolver
(127.0.0.11) which doesn't exist in Kubernetes. Added a ConfigMap to
override the template, removing the Docker DNS resolver by using a
direct proxy_pass with no nginx variable (which would force runtime
resolution). Also adds a README with usage instructions.

Documents lessons learned in ADDING-APPS-NOTES.md:
- Note 24: nginx Docker DNS resolver doesn't work in Kubernetes; any
  nginx variable in proxy_pass (including $request_uri) forces runtime
  DNS resolution requiring a resolver directive
- Note 25: ConfigMap changes don't restart pods; subPath mounts never
  auto-update; always follow with kubectl rollout restart
- Note 26: includeSelectors mismatch affects every deployment in an
  app — check all endpoints, not just the web-facing one

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-22 04:08:04 +00:00
17 changed files with 1300 additions and 24 deletions

View File

@@ -179,6 +179,114 @@ Node registration flow: when a Tailscale client connects via browser (not pre-au
shows a command like `headscale auth register --auth-id hskey-authreq-XXXX --user USERNAME`.
Run it via `kubectl exec -n headscale deploy/headscale -- headscale auth register --auth-id <id> --user <username>`.
### 21. "No available server" from Traefik — kustomize label selector mismatch
If a deployment was originally created without kustomize labels in its selector (or with stale templates), re-deploying via `wild app deploy` cannot fix it because `spec.selector` on a Deployment is immutable once set. The Service selector will update (it's mutable) but pods won't match it, leaving the Service with no endpoints.
- **Symptom**: Traefik returns "No available server" even though pods are Running
- **Diagnosis**: `kubectl get endpoints <app> -n <namespace>` shows `<none>`; pod labels don't include `app: <name>` / `managedBy: kustomize` / `partOf: wild-cloud`
- **Fix**: Delete the affected deployments and re-apply kustomize — `kubectl delete deployment <name> -n <ns>` then `kubectl apply -k <instance>/apps/<app>/`
- **Root cause**: The Deployment selector is set correctly on first deploy, but if the resource already existed with only `component: web` (e.g., from a pre-kustomize deployment), the selector is stuck
### 22. Apps using same-origin iframes need SAMEORIGIN frame policy
The global Traefik `security-headers` middleware applies `X-Frame-Options: SAMEORIGIN` to all responses (changed from `DENY`). Apps that use iframes internally (like Etherpad's pad editor, which loads `../static/empty.html` in an iframe) were broken by the stricter `DENY` policy.
- **Root cause**: `DENY` prevents even same-origin iframes. `SAMEORIGIN` still blocks cross-origin embedding while allowing apps to embed their own sub-pages.
- **Symptoms**: JavaScript error `Blocked a frame with origin "https://..." from accessing a cross-origin frame` — occurs when an app creates a same-origin iframe and then the `X-Frame-Options: DENY` header causes the browser to block access to it.
- **Important**: Route-level Traefik middlewares run BEFORE entrypoint middlewares on the response path. A per-app middleware cannot override a global entrypoint middleware — the entrypoint middleware always runs last.
- **Fix applied globally**: Changed `frameDeny: true` to `X-Frame-Options: SAMEORIGIN` in `customResponseHeaders` in the crowdsec `security-headers` middleware.
- **Affects**: Etherpad (pad editor iframe), any app that loads sub-pages in iframes on the same domain.
### 24. nginx proxy containers: Docker DNS resolver (`127.0.0.11`) doesn't work in Kubernetes
Apps that use nginx as a frontend proxy (e.g., karrot-frontend) often ship with an nginx config template that uses Docker's embedded DNS resolver:
```nginx
resolver 127.0.0.11 valid=3s;
set $backend app-backend:8000;
proxy_pass http://$backend$request_uri;
```
This fails in Kubernetes with `send() failed (111: Connection refused) while resolving, resolver: 127.0.0.11`. There's a second trap: **any nginx variable anywhere in the `proxy_pass` URL** (even `$request_uri` in the path) forces runtime DNS resolution and requires a `resolver` directive. Removing the resolver line but keeping `proxy_pass http://backend:8000$request_uri;` still fails with `no resolver defined to resolve backend`.
**Fix**: override the nginx config template via a ConfigMap mounted with `subPath`, and remove the variable from `proxy_pass` entirely:
```nginx
# Instead of:
resolver 127.0.0.11 valid=3s;
set $backend ${BACKEND};
proxy_pass http://$backend$request_uri;
# Use:
proxy_pass http://${BACKEND};
```
With no nginx variable in `proxy_pass`, nginx resolves the hostname at startup using the pod's `/etc/resolv.conf` (which points to CoreDNS). The full request URI is still forwarded automatically in a regex `location ~` block. Mount the ConfigMap with `subPath` to override just the template file without replacing the whole directory.
### 25. ConfigMap changes don't restart pods — and `subPath` mounts never auto-update
When you update a ConfigMap and run `wild app deploy` (`kubectl apply`), the ConfigMap object is updated but **pods are not restarted**. You must explicitly restart them:
```bash
kubectl rollout restart deployment/<name> -n <namespace>
```
There's a further subtlety: ConfigMaps mounted with `subPath` are **never** live-updated in the pod filesystem, even if you wait. The pod must be restarted to pick up changes regardless of the `subPath` mount update behavior.
This means: after any ConfigMap change, always follow up with a rollout restart for affected deployments.
### 26. The `includeSelectors: true` mismatch affects every deployment in the app — check them all
When diagnosing "no available server" from Traefik (note #21), it's easy to focus only on the deployment that serves the HTTP route and miss other deployments in the same namespace. The `includeSelectors: true` label propagation affects every resource in the kustomization — if any deployment pre-existed with only `component: X` labels, its Service will have `<none>` endpoints and dependent services (backends, workers, Redis) will silently fail.
**Always run this after any selector-related redeploy**:
```bash
kubectl get endpoints --all-namespaces | grep "<none>"
```
Check every deployment in the affected namespace, not just the one Traefik is routing to. A Redis pod with `<none>` endpoints will cause the backend to crash with `ConnectionError` even though the Redis pod itself shows `1/1 Running`.
**Checklist when fixing a selector mismatch in an app**:
1. `kubectl get endpoints -n <app>` — identify all services with `<none>`
2. `kubectl get pods -n <app> --show-labels` — confirm which pods have old labels
3. Delete ALL affected deployments (not just the web one), then redeploy
4. Verify all endpoints are populated before declaring the app fixed
### 23. Post-deploy admin scripts for apps that require manual first-run steps
Some apps can't complete setup through the web UI until an initial admin account is created via a CLI command. Package these as shell scripts in `scripts/` alongside the kustomize files so users have a repeatable, documented way to run them.
**When to add a script**: If the app's README or upstream docs require running a management command after deploy (creating a superuser, registering a node, inviting the first user, etc.) — wrap it in a script.
**Always register scripts in `manifest.yaml`** — the web UI automatically shows a button with a parameter form for every script listed there. Without this, users have to drop to the CLI even though the UI fully supports it. Format:
```yaml
scripts:
- name: create-superuser
path: scripts/create-superuser.sh
description: "Short description shown in the UI."
params:
- name: EMAIL
description: Description shown in the param form
required: true
- name: PASSWORD
description: Leave blank to generate a random one
```
**Script conventions** (follow `synapse/versions/v1/scripts/create-user.sh` as the reference):
- Require `KUBECONFIG`, `WILD_INSTANCE`, and `WILD_API_DATA_DIR` env vars; exit with a clear error if missing
- Read `namespace` from `config.yaml` via `yq` so the script doesn't hardcode values
- Auto-generate passwords with `openssl rand` if `PASSWORD` is not supplied
- Find the running pod by label (don't hardcode a pod name); fail clearly if none found
- Print credentials at the end with a "save this — it won't be shown again" warning
- Reference the script in the app README's "First-Time Setup" section in place of a raw `kubectl exec` command
**Non-interactive Django `createsuperuser`**:
```bash
kubectl exec -n <ns> <pod> -c <container> -- \
env DJANGO_SUPERUSER_PASSWORD="${PASSWORD}" \
python manage.py createsuperuser --email "${EMAIL}" --noinput
```
The `--noinput` flag reads the password from `DJANGO_SUPERUSER_PASSWORD`.
**Affected apps so far**: Eventyay (`scripts/create-superuser.sh`), Synapse (`scripts/create-user.sh`), Headscale (`scripts/register-node.sh`).
## App Status Tracking
| App | Status | Notes |
@@ -220,7 +328,7 @@ Run it via `kubectl exec -n headscale deploy/headscale -- headscale auth registe
| uMap | ✅ working | Host header needed in health probes (Django ALLOWED_HOSTS) |
| MapComplete | pending | |
| Terrastories | pending | |
| Karrot | already done | |
| Karrot | ✅ working | nginx frontend: override template via ConfigMap to remove Docker DNS resolver (see note 24) |
| LiquidFeedback | pending | |
| Your Priorities | ❌ blocked | No public Docker images (ghcr.io requires auth) |
| Helios Voting | pending | |

32
admin/scripts/validate-app.sh Executable file
View File

@@ -0,0 +1,32 @@
#!/usr/bin/env bash
# Validate a Wild Cloud app package before submitting.
#
# Usage:
# From your app directory: ../../admin/scripts/validate-app.sh
# From wild-directory root: admin/scripts/validate-app.sh <app-name>
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
WILD_DIR="$(cd "$SCRIPT_DIR/../.." && pwd)"
if [ $# -ge 1 ]; then
APP_NAME="$1"
else
CURRENT="$(pwd)"
if [[ "$CURRENT" == "$WILD_DIR"/* ]]; then
RELATIVE="${CURRENT#"$WILD_DIR"/}"
APP_NAME="${RELATIVE%%/*}"
else
echo "Usage: validate-app.sh <app-name>" >&2
echo " or run from inside your app directory." >&2
exit 1
fi
fi
if [ ! -d "$WILD_DIR/$APP_NAME" ]; then
echo "App not found: $APP_NAME" >&2
exit 1
fi
echo "Validating: $APP_NAME"
python3 "$SCRIPT_DIR/validate-apps.py" "$APP_NAME"

573
admin/scripts/validate-apps.py Executable file
View File

@@ -0,0 +1,573 @@
#!/usr/bin/env python3
"""Validate Wild Directory app packages for common authoring errors.
Usage:
python3 admin/scripts/validate-apps.py [app-name ...]
python3 admin/scripts/validate-apps.py --list-rules
With no arguments, validates all apps. Pass app names to check specific ones.
Exit code 1 if any errors are found.
To suppress specific rules for an app, add ignoreRules to its app.yaml:
ignoreRules:
- WC-HELM
- WC-SEL
"""
import os
import sys
import re
import yaml
REQUIRED_APP_YAML_FIELDS = ["name", "is", "description", "category", "latest"]
REQUIRED_MANIFEST_FIELDS = ["version"]
STANDARD_LABEL_PAIRS = {"managedBy": "kustomize", "partOf": "wild-cloud"}
HELM_LABELS = {"app.kubernetes.io/name", "app.kubernetes.io/instance", "app.kubernetes.io/component"}
MUTABLE_IMAGE_TAGS = {"latest", "main", "master", "edge", "develop", "dev", "nightly", "stable"}
GLOBAL_TEMPLATE_NAMESPACES = {"cloud", "cluster", "operator", "apps", "secrets", "app"}
def load_rules():
"""Load rule definitions from validation-rules.yaml in the same directory."""
script_dir = os.path.dirname(os.path.abspath(__file__))
rules_path = os.path.join(script_dir, "validation-rules.yaml")
with open(rules_path) as f:
data = yaml.safe_load(f)
rules = {}
remediation = {}
severity = {}
for rule_id, info in (data or {}).items():
if isinstance(info, dict):
rules[rule_id] = info.get("description", "")
severity[rule_id] = info.get("severity", "warning")
rem = info.get("remediation", "")
if rem:
remediation[rule_id] = rem.strip()
return rules, remediation, severity
RULES, REMEDIATION, SEVERITY = load_rules()
def add_error(errors, ignored_rules, rule_id, message):
if rule_id not in ignored_rules:
errors.append((rule_id, message))
def add_warning(warnings, ignored_rules, rule_id, message):
if rule_id not in ignored_rules:
warnings.append((rule_id, message))
def strip_gomplate(text):
"""Replace gomplate expressions with a placeholder so the file parses as valid YAML."""
return re.sub(r"\{\{.*?\}\}", "PLACEHOLDER", text, flags=re.DOTALL)
def load_yaml(path):
with open(path) as f:
content = f.read()
return yaml.safe_load(strip_gomplate(content))
def load_yaml_all(path):
"""Yield all YAML documents in a file (handles multi-doc files)."""
with open(path) as f:
content = f.read()
yield from yaml.safe_load_all(strip_gomplate(content))
def resource_docs(kustomize_dir, resources):
"""Yield (filepath, doc) for each YAML document in listed resource files."""
for resource in resources:
path = os.path.join(kustomize_dir, resource)
if not os.path.isfile(path):
continue
try:
for doc in load_yaml_all(path):
if doc:
yield path, doc
except Exception:
pass
def resources_have_workloads(kustomize_dir, resources):
"""Return True if any listed resource file contains a Deployment or StatefulSet."""
for _, doc in resource_docs(kustomize_dir, resources):
if doc.get("kind") in ("Deployment", "StatefulSet"):
return True
return False
def check_security_context(spec, resource_name, errors, warnings, ignored_rules):
"""Check pod-level and container-level security contexts."""
pod_spec = spec.get("template", {}).get("spec", {}) if "template" in spec else spec
if not pod_spec:
return
pod_sc = pod_spec.get("securityContext")
if not pod_sc:
add_warning(warnings, ignored_rules, "WC-SC-POD",
f"{resource_name}: no pod-level securityContext")
for container in pod_spec.get("containers", []) + pod_spec.get("initContainers", []):
cname = container.get("name", "?")
csc = container.get("securityContext")
if not csc:
add_warning(warnings, ignored_rules, "WC-SC-CTR",
f"{resource_name}/{cname}: no container-level securityContext")
def check_mysql_db_init(kustomize_dir, resources, errors, warnings, ignored_rules):
"""Check MySQL db-init SQL for the idempotent password pattern (WC-DBIN)."""
for resource in resources:
path = os.path.join(kustomize_dir, resource)
if not os.path.isfile(path):
continue
try:
with open(path) as f:
content = f.read()
except Exception:
continue
# Only files that contain MySQL-style SQL (IDENTIFIED BY is MySQL-specific)
if "CREATE USER" not in content or "IDENTIFIED BY" not in content:
continue
if "ALTER USER" not in content:
add_error(errors, ignored_rules, "WC-DBIN",
f"{os.path.basename(path)}: MySQL CREATE USER IF NOT EXISTS without ALTER USER"
" — passwords won't update on redeploy (see note #17)")
def check_docker_dns(kustomize_dir, resources, errors, warnings, ignored_rules):
"""Check for Docker DNS resolver (127.0.0.11) which doesn't work in Kubernetes (WC-DKRDNS)."""
for resource in resources:
path = os.path.join(kustomize_dir, resource)
if not os.path.isfile(path):
continue
try:
with open(path) as f:
content = f.read()
except Exception:
continue
if "127.0.0.11" in content:
add_error(errors, ignored_rules, "WC-DKRDNS",
f"{os.path.basename(path)}: contains Docker DNS resolver (127.0.0.11)"
" — use CoreDNS instead (see note #24)")
def check_resource_parse_errors(kustomize_dir, resources, errors, warnings, ignored_rules):
"""Check that all listed resource files parse as valid YAML (WC-RES-PARSE)."""
for resource in resources:
path = os.path.join(kustomize_dir, resource)
if not os.path.isfile(path):
continue # WC-RES already handles missing files
try:
list(load_yaml_all(path))
except Exception as e:
add_error(errors, ignored_rules, "WC-RES-PARSE",
f"{resource}: YAML parse error: {e}")
def check_namespace_resource(kustomize_dir, resources, errors, warnings, ignored_rules):
"""Check that a Namespace resource exists when workloads are present (WC-NSFILE)."""
if not resources_have_workloads(kustomize_dir, resources):
return
for _, doc in resource_docs(kustomize_dir, resources):
if doc.get("kind") == "Namespace":
return
add_warning(warnings, ignored_rules, "WC-NSFILE",
"no Namespace resource in kustomization.yaml — add namespace.yaml")
def check_template_vars(kustomize_dir, default_config, errors, warnings, ignored_rules):
"""Check top-level template variables in resource files against defaultConfig (WC-TVAR)."""
if not default_config:
return
defined_keys = set(default_config.keys())
for fname in sorted(os.listdir(kustomize_dir)):
if not fname.endswith(".yaml") or fname == "manifest.yaml":
continue
path = os.path.join(kustomize_dir, fname)
try:
with open(path) as f:
content = f.read()
except Exception:
continue
seen_undefined = set()
for block in re.finditer(r"\{\{-?\s*(.*?)\s*-?\}\}", content, re.DOTALL):
for m in re.finditer(r"(?<![.\w])\.([a-z]\w*)", block.group(1)):
var_name = m.group(1)
if var_name in GLOBAL_TEMPLATE_NAMESPACES:
continue
if var_name not in defined_keys and var_name not in seen_undefined:
seen_undefined.add(var_name)
add_warning(warnings, ignored_rules, "WC-TVAR",
f"{fname}: template variable .{var_name!r} not in defaultConfig")
def validate_resources(kustomize_dir, resources, errors, warnings, ignored_rules):
"""Run per-document checks on all resource files."""
rwo_pvc_names = set()
# First pass: collect RWO PVC claim names
for _, doc in resource_docs(kustomize_dir, resources):
if doc.get("kind") == "PersistentVolumeClaim":
access_modes = doc.get("spec", {}).get("accessModes", [])
if "ReadWriteOnce" in access_modes:
rwo_pvc_names.add(doc.get("metadata", {}).get("name", ""))
# Second pass: validate each document
for fpath, doc in resource_docs(kustomize_dir, resources):
fname = os.path.basename(fpath)
kind = doc.get("kind", "")
name = doc.get("metadata", {}).get("name", fname)
label_ref = f"{fname}:{name}"
if kind in ("Deployment", "StatefulSet", "DaemonSet"):
spec = doc.get("spec", {})
# Security context
check_security_context(spec, label_ref, errors, warnings, ignored_rules)
# RWO PVC → must use Recreate strategy
if kind == "Deployment":
volumes = spec.get("template", {}).get("spec", {}).get("volumes", [])
uses_rwo = any(
v.get("persistentVolumeClaim", {}).get("claimName") in rwo_pvc_names
for v in volumes
)
if uses_rwo:
strategy = spec.get("strategy", {}).get("type", "RollingUpdate")
if strategy != "Recreate":
add_error(errors, ignored_rules, "WC-RWO",
f"{label_ref}: ReadWriteOnce PVC requires strategy: Recreate (got {strategy!r})")
# No Helm-style labels in pod template
pod_labels = spec.get("template", {}).get("metadata", {}).get("labels", {}) or {}
for helm_label in HELM_LABELS:
if helm_label in pod_labels:
add_error(errors, ignored_rules, "WC-HELM",
f"{label_ref}: Helm-style label {helm_label!r} found — use simple component labels instead")
# Image tags and sources
pod_spec = spec.get("template", {}).get("spec", {}) or {}
for container in pod_spec.get("containers", []) + pod_spec.get("initContainers", []):
image = container.get("image", "")
cname = container.get("name", "?")
tag = image.split(":")[-1] if ":" in image else ""
if tag.lower() in MUTABLE_IMAGE_TAGS:
add_error(errors, ignored_rules, "WC-IMG",
f"{label_ref}/{cname}: image tag {tag!r} is mutable — use a specific version tag")
elif not tag:
add_warning(warnings, ignored_rules, "WC-IMG",
f"{label_ref}/{cname}: image has no tag — specify a version")
if re.search(r"(?:^|/)bitnami", image.split(":")[0]):
add_warning(warnings, ignored_rules, "WC-BITNAMI",
f"{label_ref}/{cname}: uses a Bitnami image ({image.split(':')[0]!r})"
" — prefer an official image")
elif kind == "Ingress":
annotations = doc.get("metadata", {}).get("annotations", {}) or {}
spec = doc.get("spec", {}) or {}
# Must use spec.ingressClassName, not annotation
if "kubernetes.io/ingress.class" in annotations:
add_error(errors, ignored_rules, "WC-ING-ANN",
f"{label_ref}: use spec.ingressClassName: traefik, not kubernetes.io/ingress.class annotation")
if spec.get("ingressClassName") != "traefik":
add_warning(warnings, ignored_rules, "WC-ING-CLS",
f"{label_ref}: spec.ingressClassName should be 'traefik' (got {spec.get('ingressClassName')!r})")
# No cert-manager annotation (wildcard cert is pre-distributed)
if "cert-manager.io/cluster-issuer" in annotations:
add_error(errors, ignored_rules, "WC-CERT",
f"{label_ref}: do not use cert-manager.io/cluster-issuer — wildcard TLS cert is pre-distributed to namespaces")
# External-dns target annotation
if "external-dns.alpha.kubernetes.io/target" not in annotations:
add_warning(warnings, ignored_rules, "WC-DNS",
f"{label_ref}: missing external-dns.alpha.kubernetes.io/target annotation")
def validate_kustomization(kustomize_dir, app_name, default_config, errors, warnings, ignored_rules):
path = os.path.join(kustomize_dir, "kustomization.yaml")
if not os.path.exists(path):
add_error(errors, ignored_rules, "WC-KUS-MISS", "MISSING kustomization.yaml")
return
try:
data = load_yaml(path)
except Exception as e:
add_error(errors, ignored_rules, "WC-KUS-PARSE", f"PARSE ERROR in kustomization.yaml: {e}")
return
if not data:
add_error(errors, ignored_rules, "WC-KUS-EMPTY", "EMPTY kustomization.yaml")
return
# Check all listed resources exist on disk
resources = data.get("resources") or []
for resource in resources:
resource_path = os.path.join(kustomize_dir, resource)
if not os.path.exists(resource_path):
add_error(errors, ignored_rules, "WC-RES", f"resource not found: {resource}")
has_workloads = resources_have_workloads(kustomize_dir, resources)
if has_workloads:
if "namespace" not in data:
add_warning(warnings, ignored_rules, "WC-NS",
"no namespace set in kustomization.yaml (has Deployment/StatefulSet)")
# Require includeSelectors: true
labels = data.get("labels") or []
include_selectors_entries = [
lbl for lbl in labels
if isinstance(lbl, dict) and lbl.get("includeSelectors") is True
]
if not include_selectors_entries:
add_error(errors, ignored_rules, "WC-SEL",
"labels.includeSelectors: true missing (required when Deployment/StatefulSet present)")
else:
pairs = include_selectors_entries[0].get("pairs") or {}
for key, expected in STANDARD_LABEL_PAIRS.items():
if pairs.get(key) != expected:
add_warning(warnings, ignored_rules, "WC-PAIRS",
f"label pair {key}: {expected!r} missing or wrong")
# app label should match the app directory name
if pairs.get("app") and pairs.get("app") != app_name:
add_warning(warnings, ignored_rules, "WC-LBL",
f"label pair app: {pairs['app']!r} doesn't match app directory name {app_name!r}")
# Per-resource checks
check_resource_parse_errors(kustomize_dir, resources, errors, warnings, ignored_rules)
validate_resources(kustomize_dir, resources, errors, warnings, ignored_rules)
check_mysql_db_init(kustomize_dir, resources, errors, warnings, ignored_rules)
check_docker_dns(kustomize_dir, resources, errors, warnings, ignored_rules)
check_namespace_resource(kustomize_dir, resources, errors, warnings, ignored_rules)
check_template_vars(kustomize_dir, default_config, errors, warnings, ignored_rules)
def validate_manifest(version_dir, errors, warnings, ignored_rules):
manifest_path = os.path.join(version_dir, "manifest.yaml")
if not os.path.exists(manifest_path):
add_error(errors, ignored_rules, "WC-MAN-MISS", "MISSING manifest.yaml")
return
try:
manifest = load_yaml(manifest_path)
except Exception as e:
add_error(errors, ignored_rules, "WC-MAN-PARSE", f"PARSE ERROR in manifest.yaml: {e}")
return
if not manifest:
add_error(errors, ignored_rules, "WC-MAN-EMPTY", "EMPTY manifest.yaml")
return
for field in REQUIRED_MANIFEST_FIELDS:
if field not in manifest:
add_error(errors, ignored_rules, "WC-MAN-REQ",
f"manifest.yaml missing field: {field}")
# defaultConfig should have a namespace field
default_config = manifest.get("defaultConfig") or {}
if not default_config:
add_warning(warnings, ignored_rules, "WC-CFG",
"manifest.yaml: defaultConfig is empty or missing")
elif "namespace" not in default_config:
add_warning(warnings, ignored_rules, "WC-CFG-NS",
"manifest.yaml: defaultConfig missing 'namespace' field")
# Check postgres dbUrl secrets contain ?sslmode=disable
for secret in manifest.get("defaultSecrets") or []:
if not isinstance(secret, dict):
continue
default = str(secret.get("default", ""))
if ("postgres" in default or "postgresql" in default) and "sslmode" not in default:
add_error(errors, ignored_rules, "WC-SSL",
f"manifest.yaml: defaultSecret {secret.get('key')!r} has postgres URL without ?sslmode=disable")
# requiredSecrets should use <app-ref>.<key> format
for rs in manifest.get("requiredSecrets") or []:
if isinstance(rs, str) and "." not in rs:
add_error(errors, ignored_rules, "WC-DOT",
f"manifest.yaml: requiredSecret {rs!r} missing dot notation (<app-ref>.<key>)")
def validate_version(version_dir, app_name, errors, warnings, ignored_rules):
validate_manifest(version_dir, errors, warnings, ignored_rules)
# Load defaultConfig for template variable checking
default_config = {}
manifest_path = os.path.join(version_dir, "manifest.yaml")
if os.path.exists(manifest_path):
try:
manifest_data = load_yaml(manifest_path) or {}
default_config = manifest_data.get("defaultConfig") or {}
except Exception:
pass
# Config-only apps (e.g. smtp) have no kubernetes resources — skip kustomization check
kustomize_path = os.path.join(version_dir, "kustomization.yaml")
resource_yamls = [
f for f in os.listdir(version_dir)
if f.endswith(".yaml") and f not in ("manifest.yaml", "kustomization.yaml")
]
if os.path.exists(kustomize_path) or resource_yamls:
validate_kustomization(version_dir, app_name, default_config, errors, warnings, ignored_rules)
def validate_app(app_dir):
errors = []
warnings = []
app_name = os.path.basename(app_dir)
app_yaml_path = os.path.join(app_dir, "app.yaml")
if not os.path.exists(app_yaml_path):
return [("WC-APP-MISS", "MISSING app.yaml")], []
try:
app_data = load_yaml(app_yaml_path)
except Exception as e:
return [("WC-APP-PARSE", f"PARSE ERROR in app.yaml: {e}")], []
if not app_data:
return [("WC-APP-EMPTY", "EMPTY app.yaml")], []
ignored_rules = set(app_data.get("ignoreRules") or [])
# Flag any ignoreRules entries that don't correspond to a known rule
for rule_id in ignored_rules:
if rule_id not in RULES:
errors.append(("WC-IGN", f"app.yaml ignoreRules contains unknown rule: {rule_id!r}"))
for field in REQUIRED_APP_YAML_FIELDS:
if not app_data.get(field):
add_error(errors, ignored_rules, "WC-REQ",
f"app.yaml missing required field: {field}")
# icon is cosmetic — warn rather than error
if not app_data.get("icon"):
add_warning(warnings, ignored_rules, "WC-ICON", "app.yaml missing field: icon")
# name must match directory name
if app_data.get("name") and app_data["name"] != app_name:
add_error(errors, ignored_rules, "WC-NAME",
f"app.yaml name {app_data['name']!r} doesn't match directory name {app_name!r}")
latest = str(app_data.get("latest", ""))
versions_dir = os.path.join(app_dir, "versions")
if not os.path.isdir(versions_dir):
add_error(errors, ignored_rules, "WC-VER", "MISSING versions/ directory")
return errors, warnings
# Check slot naming convention and validate each slot
for slot_name in sorted(os.listdir(versions_dir)):
slot_path = os.path.join(versions_dir, slot_name)
if not os.path.isdir(slot_path):
continue
# Flag full version strings (two or more dots) or packaging revision suffix (-N)
if re.search(r"\.\d+\.\d+", slot_name) or re.search(r"-\d+$", slot_name):
add_warning(warnings, ignored_rules, "WC-SLOT",
f"versions/{slot_name}: slot name looks like a full version or revision"
" — use the major version only (e.g. '1', 'v1')")
if latest:
latest_dir = os.path.join(versions_dir, latest)
if not os.path.isdir(latest_dir):
add_error(errors, ignored_rules, "WC-LATEST",
f"latest version directory not found: versions/{latest}")
else:
ver_errors, ver_warnings = [], []
validate_version(latest_dir, app_name, ver_errors, ver_warnings, ignored_rules)
errors.extend((rule_id, f"versions/{latest}: {msg}") for rule_id, msg in ver_errors)
warnings.extend((rule_id, f"versions/{latest}: {msg}") for rule_id, msg in ver_warnings)
# Check that upgrade waypoint slots exist
upgrade = app_data.get("upgrade") or {}
for rule in upgrade.get("from") or []:
via = rule.get("via")
if via:
via_dir = os.path.join(versions_dir, str(via))
if not os.path.isdir(via_dir):
add_error(errors, ignored_rules, "WC-VIA",
f"app.yaml upgrade.from[].via={via!r} references a non-existent slot")
return errors, warnings
def main():
args = sys.argv[1:]
if "--list-rules" in args:
print("Rule IDs for use in app.yaml ignoreRules:\n")
for rule_id in RULES:
sev = SEVERITY.get(rule_id, "warning")
print(f" {rule_id:<14} {sev:<8} {RULES[rule_id]}")
if rule_id in REMEDIATION:
lines = REMEDIATION[rule_id].split("\n")
print(f" {'':<14} Fix: {lines[0]}")
for line in lines[1:]:
print(f" {'':<14} {line}")
return 0
requested = [a for a in args if not a.startswith("--")]
wild_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
if requested:
app_dirs = []
for name in requested:
path = os.path.join(wild_dir, name)
if not os.path.isdir(path):
print(f"ERROR: {name} not found in wild-directory", file=sys.stderr)
sys.exit(1)
app_dirs.append(path)
else:
app_dirs = sorted(
os.path.join(wild_dir, d)
for d in os.listdir(wild_dir)
if os.path.isdir(os.path.join(wild_dir, d))
and not d.startswith(".")
and os.path.exists(os.path.join(wild_dir, d, "app.yaml"))
)
total_errors = 0
total_warnings = 0
for app_dir in app_dirs:
app_name = os.path.basename(app_dir)
errors, warnings = validate_app(app_dir)
if errors or warnings:
print(f"\n{app_name}:")
shown_remediation = set()
for rule_id, msg in errors:
print(f" ERROR [{rule_id}] {msg}")
if rule_id in REMEDIATION and rule_id not in shown_remediation:
lines = REMEDIATION[rule_id].split("\n")
print(f" Fix: {lines[0]}")
for line in lines[1:]:
print(f" {line}")
shown_remediation.add(rule_id)
for rule_id, msg in warnings:
print(f" WARN [{rule_id}] {msg}")
if rule_id in REMEDIATION and rule_id not in shown_remediation:
lines = REMEDIATION[rule_id].split("\n")
print(f" Fix: {lines[0]}")
for line in lines[1:]:
print(f" {line}")
shown_remediation.add(rule_id)
total_errors += len(errors)
total_warnings += len(warnings)
print(f"\n{''*50}")
print(f"checked {len(app_dirs)} apps • {total_errors} errors • {total_warnings} warnings")
return 1 if total_errors > 0 else 0
if __name__ == "__main__":
sys.exit(main())

View File

@@ -0,0 +1,284 @@
# Wild Cloud App Validation Rules
#
# Loaded by validate-apps.py at runtime.
# Run `validate-apps.py --list-rules` for a formatted summary.
#
# To suppress a rule for an app, add its ID to ignoreRules in app.yaml:
# ignoreRules:
# - WC-HELM # upstream Helm-rendered manifests
#
# Fields:
# severity: error (must fix before submitting) | warning (strong suggestion)
# description: What the rule checks for
# remediation: How to fix the issue
# ── app.yaml ──────────────────────────────────────────────────────────────────
WC-APP-MISS:
severity: error
description: app.yaml file is missing
remediation: Create app.yaml with name, description, category, latest, and icon fields
WC-IGN:
severity: error
description: app.yaml ignoreRules contains an unknown rule ID
remediation: Remove the stale entry from ignoreRules, or check for a typo in the rule ID (run --list-rules to see valid IDs)
WC-APP-PARSE:
severity: error
description: app.yaml could not be parsed as valid YAML
remediation: Fix YAML syntax errors in app.yaml
WC-APP-EMPTY:
severity: error
description: app.yaml is empty
remediation: Populate app.yaml — it is empty
WC-REQ:
severity: error
description: app.yaml missing one or more required fields
remediation: "Add the missing fields: name, is, description, category, and latest are all required"
WC-NAME:
severity: error
description: app.yaml name does not match the directory name
remediation: "Set 'name:' in app.yaml to exactly match the directory name"
WC-ICON:
severity: warning
description: app.yaml missing icon field
remediation: "Add 'icon: <url>' to app.yaml pointing to the app's logo"
# ── versions ──────────────────────────────────────────────────────────────────
WC-VER:
severity: error
description: versions/ directory is missing
remediation: Create a versions/ subdirectory with at least one version slot directory inside it
WC-LATEST:
severity: error
description: latest version directory does not exist
remediation: "Create the version slot directory named in 'latest:', or update 'latest:' to an existing slot"
WC-VIA:
severity: error
description: upgrade.from[].via references a slot directory that does not exist
remediation: "Create the waypoint slot directory, or fix the via: value to match an existing slot"
WC-SLOT:
severity: warning
description: version slot directory name looks like a full version string or packaging revision
remediation: |
Rename the slot to the major version only (e.g. '1', 'v1', 'v0').
Full versions ('1.2.3') and packaging revisions ('1-2') do not belong in directory names.
The actual version string lives in manifest.yaml.
# ── manifest.yaml ─────────────────────────────────────────────────────────────
WC-NSFILE:
severity: warning
description: no Namespace resource defined — workloads will deploy into an unmanaged namespace
remediation: |
Add a namespace.yaml listing it in kustomization.yaml resources:
apiVersion: v1
kind: Namespace
metadata:
name: {{ .namespace }}
# ── manifest.yaml ─────────────────────────────────────────────────────────────
WC-MAN-MISS:
severity: error
description: manifest.yaml is missing
remediation: "Create manifest.yaml with at minimum: version, defaultConfig.namespace"
WC-MAN-PARSE:
severity: error
description: manifest.yaml could not be parsed
remediation: Fix YAML syntax errors in manifest.yaml
WC-MAN-EMPTY:
severity: error
description: manifest.yaml is empty
remediation: Populate manifest.yaml — it is empty
WC-MAN-REQ:
severity: error
description: manifest.yaml missing a required field
remediation: "Add the missing field to manifest.yaml (at minimum: version)"
WC-TVAR:
severity: warning
description: template variable in resource file not found in defaultConfig
remediation: |
Add the missing variable to defaultConfig in manifest.yaml, or check for a typo in the template.
Only top-level variable names are checked — e.g. .db in {{ .db.host }} must appear as a key under defaultConfig.
Global namespaces (cloud, cluster, operator, apps, secrets, app) are always available and exempt.
WC-CFG:
severity: warning
description: manifest.yaml defaultConfig is empty or missing
remediation: "Add a 'defaultConfig:' block to manifest.yaml"
WC-CFG-NS:
severity: warning
description: manifest.yaml defaultConfig missing namespace field
remediation: "Add 'namespace: <app-name>' under defaultConfig in manifest.yaml"
WC-SSL:
severity: error
description: postgres URL missing ?sslmode=disable
remediation: |
Append ?sslmode=disable to the postgres connection URL:
postgresql://user:pass@host:5432/db?sslmode=disable
WC-DOT:
severity: error
description: requiredSecret does not use <app-ref>.<key> dot notation
remediation: "Use <app-ref>.<key> format in requiredSecrets (e.g. postgres.password, not just 'password')"
# ── kustomization.yaml ────────────────────────────────────────────────────────
WC-KUS-MISS:
severity: error
description: kustomization.yaml is missing
remediation: Create kustomization.yaml listing all resource files with Wild Cloud labels
WC-KUS-PARSE:
severity: error
description: kustomization.yaml could not be parsed
remediation: Fix YAML syntax errors in kustomization.yaml
WC-KUS-EMPTY:
severity: error
description: kustomization.yaml is empty
remediation: "Add a resources: list and labels: block to kustomization.yaml"
WC-RES:
severity: error
description: a resource listed in kustomization.yaml does not exist on disk
remediation: "Create the missing file, or remove it from resources: in kustomization.yaml"
WC-RES-PARSE:
severity: error
description: a resource file listed in kustomization.yaml could not be parsed as valid YAML
remediation: Fix YAML syntax errors in the resource file
WC-NS:
severity: warning
description: no namespace in kustomization.yaml (has Deployment/StatefulSet)
remediation: "Add 'namespace: {{ .namespace }}' to kustomization.yaml"
WC-SEL:
severity: error
description: labels.includeSelectors true missing (required for Deployment/StatefulSet)
remediation: |
Add to kustomization.yaml:
labels:
- includeSelectors: true
pairs:
app: <app-name>
managedBy: kustomize
partOf: wild-cloud
WC-PAIRS:
severity: warning
description: a standard label pair is missing or has the wrong value
remediation: "Ensure labels.pairs includes managedBy: kustomize and partOf: wild-cloud"
WC-LBL:
severity: warning
description: label pair 'app' does not match the app directory name
remediation: "Set 'app:' in label pairs to match the app directory name"
# ── workloads ─────────────────────────────────────────────────────────────────
WC-SC-POD:
severity: warning
description: no pod-level securityContext defined
remediation: |
Add to the pod spec:
securityContext:
runAsNonRoot: true
runAsUser: <uid>
seccompProfile:
type: RuntimeDefault
WC-SC-CTR:
severity: warning
description: no container-level securityContext defined
remediation: |
Add to each container spec:
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop: [ALL]
WC-RWO:
severity: error
description: Deployment using a ReadWriteOnce PVC must use strategy Recreate
remediation: "Set strategy: type: Recreate on the Deployment — RWO volumes cannot attach to two pods at once"
WC-HELM:
severity: error
description: Helm-style app.kubernetes.io/* labels found in pod template
remediation: "Remove app.kubernetes.io/* labels from pod template; use simple labels (e.g. component: web) instead"
WC-IMG:
severity: error
description: container image uses a mutable or missing version tag
remediation: "Pin the image to a specific release tag (e.g. myimage:1.2.3), not latest/main/stable/etc."
WC-BITNAMI:
severity: warning
description: container image is from Bitnami — prefer an official image
remediation: |
Replace the Bitnami image with the official upstream image.
Bitnami images require Docker Hub authentication since 2023, use non-standard filesystem layouts,
and are often a sign of a Helm chart that wasn't fully adapted. Check Docker Hub or the project's
docs for the official image (e.g. postgres:15, redis:alpine, mariadb:11).
# ── ingress ───────────────────────────────────────────────────────────────────
WC-ING-ANN:
severity: error
description: ingress uses deprecated kubernetes.io/ingress.class annotation
remediation: "Replace the annotation with spec.ingressClassName: traefik in the Ingress spec"
WC-ING-CLS:
severity: warning
description: ingress spec.ingressClassName should be traefik
remediation: "Add 'ingressClassName: traefik' under spec: in the Ingress"
WC-CERT:
severity: error
description: ingress uses cert-manager annotation (wildcard cert is pre-distributed)
remediation: "Remove the cert-manager.io/cluster-issuer annotation — wildcard TLS is pre-distributed to namespaces"
WC-DNS:
severity: warning
description: ingress missing external-dns.alpha.kubernetes.io/target annotation
remediation: |
Add to Ingress metadata.annotations:
external-dns.alpha.kubernetes.io/target: '{{ .externalDnsDomain }}'
# ── db-init ───────────────────────────────────────────────────────────────────
WC-DKRDNS:
severity: error
description: Docker DNS resolver (127.0.0.11) used — not available in Kubernetes
remediation: |
Remove `resolver 127.0.0.11` and avoid nginx variables in proxy_pass.
Use `proxy_pass http://backend-name:port;` (no variable) so nginx resolves via CoreDNS at startup.
If a runtime-resolved variable is unavoidable, use the cluster DNS resolver instead:
resolver kube-dns.kube-system.svc.cluster.local valid=30s;
See docs/nginx.md for the full pattern.
WC-DBIN:
severity: error
description: MySQL db-init uses CREATE USER without ALTER USER (passwords won't update on redeploy)
remediation: |
Add ALTER USER after CREATE USER so passwords update on redeploy:
CREATE USER IF NOT EXISTS '${USER}'@'%' IDENTIFIED BY '${PASSWORD}';
ALTER USER '${USER}'@'%' IDENTIFIED BY '${PASSWORD}';

View File

@@ -48,7 +48,6 @@ spec:
browserXssFilter: true
contentTypeNosniff: true
forceSTSHeader: true
frameDeny: true
sslRedirect: true
stsIncludeSubdomains: true
stsPreload: true
@@ -72,6 +71,7 @@ spec:
X-Forwarded-Proto: https
customResponseHeaders:
Server: ""
X-Frame-Options: SAMEORIGIN
X-Robots-Tag: noindex,nofollow,nosnippet,noarchive,notranslate,noimageindex
---
apiVersion: traefik.io/v1alpha1

View File

@@ -27,7 +27,7 @@ Key settings in `config.yaml`:
2. Create the superuser account:
```bash
kubectl exec -n eventyay deploy/eventyay -- python manage.py createsuperuser
EMAIL=you@example.com scripts/create-superuser.sh
```
3. Log in at `/orga/login/` with the credentials you just created.

View File

@@ -122,26 +122,48 @@ spec:
mountPath: /home/app/.gunicorn
livenessProbe:
httpGet:
path: /
port: 8000
httpHeaders:
- name: Host
value: "{{ .domain }}"
path: /static/pretixbase/img/eventyay-icon.svg
port: 8080
initialDelaySeconds: 120
timeoutSeconds: 10
periodSeconds: 30
failureThreshold: 6
readinessProbe:
httpGet:
path: /
port: 8000
httpHeaders:
- name: Host
value: "{{ .domain }}"
path: /static/pretixbase/img/eventyay-icon.svg
port: 8080
initialDelaySeconds: 60
timeoutSeconds: 5
periodSeconds: 15
failureThreshold: 3
- name: nginx
image: nginxinc/nginx-unprivileged:1.27-alpine
ports:
- name: nginx-http
containerPort: 8080
protocol: TCP
volumeMounts:
- name: eventyay-static
mountPath: /static
readOnly: true
- name: nginx-config
mountPath: /etc/nginx/conf.d
readOnly: true
resources:
limits:
cpu: 200m
memory: 128Mi
requests:
cpu: 10m
memory: 32Mi
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
add:
- NET_BIND_SERVICE
readOnlyRootFilesystem: false
volumes:
- name: eventyay-data
persistentVolumeClaim:
@@ -150,6 +172,9 @@ spec:
emptyDir: {}
- name: eventyay-gunicorn
emptyDir: {}
- name: nginx-config
configMap:
name: eventyay-nginx
restartPolicy: Always
---
apiVersion: apps/v1
@@ -237,9 +262,9 @@ spec:
limits:
cpu: "2"
ephemeral-storage: 1Gi
memory: 1Gi
memory: 4Gi
requests:
cpu: 50m
ephemeral-storage: 50Mi
memory: 512Mi
memory: 2Gi
restartPolicy: Always

View File

@@ -10,6 +10,7 @@ labels:
resources:
- namespace.yaml
- pvc.yaml
- nginx-configmap.yaml
- deployment.yaml
- service.yaml
- ingress.yaml

View File

@@ -1,4 +1,4 @@
version: main-2
version: main-5
requires:
- name: postgres
- name: redis
@@ -23,6 +23,16 @@ defaultConfig:
port: '{{ .apps.smtp.port }}'
from: '{{ .apps.smtp.from }}'
user: '{{ .apps.smtp.user }}'
scripts:
- name: create-superuser
path: scripts/create-superuser.sh
description: "Create an Eventyay superuser account for first-time setup."
params:
- name: EMAIL
description: Email address for the superuser account
required: true
- name: PASSWORD
description: Password (leave blank to generate a random one)
defaultSecrets:
- key: dbPassword
- key: djangoSecret

View File

@@ -0,0 +1,31 @@
apiVersion: v1
kind: ConfigMap
metadata:
name: eventyay-nginx
namespace: {{ .namespace }}
data:
nginx.conf: |
server {
listen 8080;
server_name _;
client_max_body_size 100m;
location /static/ {
alias /static/;
expires 30d;
add_header Cache-Control "public, immutable";
}
location /media/ {
alias /media/;
}
location / {
proxy_pass http://127.0.0.1:8000;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
proxy_read_timeout 120s;
}
}

View File

@@ -0,0 +1,56 @@
#!/bin/bash
# Create an Eventyay superuser (organizer admin account).
#
# Required for first-time setup — the web UI cannot be accessed until
# at least one superuser exists.
#
# Runs on the worker pod because the web pod's memory limit is too tight
# to run an additional Django process alongside gunicorn workers.
set -e
set -o pipefail
if [ -z "${KUBECONFIG}" ] || [ -z "${WILD_INSTANCE}" ] || [ -z "${WILD_API_DATA_DIR}" ]; then
echo "ERROR: KUBECONFIG, WILD_INSTANCE, and WILD_API_DATA_DIR must be set"
exit 1
fi
if [ -z "${EMAIL}" ]; then
echo "ERROR: EMAIL is required"
exit 1
fi
CONFIG_FILE="${WILD_API_DATA_DIR}/instances/${WILD_INSTANCE}/config.yaml"
NAMESPACE="$(yq '.apps.eventyay.namespace' "${CONFIG_FILE}" | tr -d '"')"
NAMESPACE="${NAMESPACE:-eventyay}"
# Run on the worker pod — same image as web, but with a higher memory limit
# which is needed to run manage.py alongside the existing gunicorn workers.
POD="$(kubectl get pods -n "${NAMESPACE}" -l component=worker --field-selector=status.phase=Running -o jsonpath='{.items[0].metadata.name}' 2>/dev/null)"
if [ -z "${POD}" ]; then
echo "ERROR: No running Eventyay worker pod found in namespace ${NAMESPACE}"
exit 1
fi
if [ -z "${PASSWORD}" ]; then
PASSWORD="$(openssl rand -base64 24 | tr -d '/+=' | head -c 24)"
fi
echo "Creating superuser '${EMAIL}'..."
kubectl exec -n "${NAMESPACE}" "${POD}" -- \
python manage.py shell -c "
from django.contrib.auth import get_user_model
User = get_user_model()
if User.objects.filter(email='${EMAIL}').exists():
raise SystemExit('ERROR: User ${EMAIL} already exists')
User.objects.create_superuser(email='${EMAIL}', password='${PASSWORD}')
"
echo ""
echo "=== Superuser created ==="
echo "Email: ${EMAIL}"
echo "Password: ${PASSWORD}"
echo ""
echo "Log in at /orga/login/ with these credentials."
echo "Save this password — it will not be shown again."

View File

@@ -9,5 +9,5 @@ spec:
ports:
- name: http
port: 80
targetPort: 8000
targetPort: 8080
protocol: TCP

View File

@@ -0,0 +1,35 @@
# Karrot
Karrot is a community platform for sharing resources, coordinating food-saving activities, and organizing volunteers. Groups can manage pickups, track saved food, and communicate through a shared feed.
## Dependencies
- **PostgreSQL** - Database for storing groups, users, and activity data
- **SMTP** - For account verification and notifications
## Configuration
Key settings in `config.yaml`:
- **domain** - Where Karrot will be accessible (default: `karrot.{your-cloud-domain}`)
- **storage** - Persistent volume size for uploaded files (default: `2Gi`)
- **redis.host** - Redis instance for caching and background jobs (default: app-local `karrot-redis`)
- **smtp** - Email settings inherited from your Wild Cloud SMTP service
## First-Time Setup
1. Add and deploy the app:
```bash
wild app add karrot
wild app deploy karrot
```
2. Visit `https://karrot.{your-cloud-domain}` and register an account. The first user to register becomes the site admin.
3. Log in and create your first group to start coordinating.
## Notes
- Karrot supports federation — groups can connect with other Karrot instances
- The `secretKey` and `dbPassword` are auto-generated in `secrets.yaml`
- Uploaded files (photos, attachments) are stored in the persistent volume and shared between the frontend and backend pods

View File

@@ -14,9 +14,9 @@ spec:
component: frontend
spec:
securityContext:
runAsNonRoot: true
runAsUser: 101
runAsGroup: 101
runAsNonRoot: false
runAsUser: 0
runAsGroup: 0
seccompProfile:
type: RuntimeDefault
containers:
@@ -60,8 +60,6 @@ spec:
failureThreshold: 3
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop: [ALL]
readOnlyRootFilesystem: false
volumeMounts:
- name: karrot-uploads
@@ -73,6 +71,9 @@ spec:
mountPath: /etc/nginx/conf.d
- name: nginx-run
mountPath: /var/run
- name: nginx-template
mountPath: /etc/nginx/templates/default.conf.template
subPath: default.conf.template
volumes:
- name: karrot-uploads
persistentVolumeClaim:
@@ -83,4 +84,7 @@ spec:
emptyDir: {}
- name: nginx-run
emptyDir: {}
- name: nginx-template
configMap:
name: karrot-nginx-template
restartPolicy: Always

View File

@@ -9,6 +9,7 @@ labels:
partOf: wild-cloud
resources:
- namespace.yaml
- nginx-template-configmap.yaml
- db-init-job.yaml
- deployment-backend.yaml
- deployment-frontend.yaml

View File

@@ -0,0 +1,116 @@
apiVersion: v1
kind: ConfigMap
metadata:
name: karrot-nginx-template
namespace: {{ .namespace }}
data:
default.conf.template: |
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
client_max_body_size ${FILE_UPLOAD_MAX_SIZE};
server {
listen ${LISTEN};
set_real_ip_from 10.0.0.0/8;
set_real_ip_from 172.16.0.0/12;
set_real_ip_from 192.168.0.0/16;
real_ip_header X-Forwarded-For;
root /usr/share/nginx/html;
location /assets {
expires max;
}
location /css {
expires max;
}
location /js {
expires max;
}
location /img {
expires max;
}
location /fonts {
expires max;
}
location / {
try_files $uri /index.html;
add_header Strict-Transport-Security "max-age=63072000; includeSubdomains; preload";
add_header X-Content-Type-Options nosniff;
add_header Last-Modified $date_gmt;
add_header Cache-Control 'no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0';
add_header Content-Security-Policy "default-src 'self'; script-src 'self' 'unsafe-eval' 'unsafe-inline'; connect-src 'self' https://nominatim.openstreetmap.org https://sentry.io https://*.ingest.sentry.io ${CSP_CONNECT_SRC} blob:; style-src 'self' 'unsafe-inline'; font-src 'self' data:; img-src 'self' https: data: blob:;";
if_modified_since off;
expires off;
etag off;
}
location /bundlesize.html {
add_header Content-Security-Policy "default-src 'self' 'unsafe-inline';";
add_header Cache-Control 'no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0';
}
location ~ ^\/(api(\-auth)?|docs|silk|static)\/ {
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header Host $http_host;
proxy_pass http://${BACKEND};
proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_set_header Sec-WebSocket-Extensions $http_sec_websocket_extensions;
proxy_set_header Sec-WebSocket-Key $http_sec_websocket_key;
proxy_set_header Sec-WebSocket-Protocol $http_sec_websocket_protocol;
proxy_set_header Sec-WebSocket-Version $http_sec_websocket_version;
}
location /media/ {
alias ${FILE_UPLOAD_DIR};
expires max;
}
location /media/tmp/ {
deny all;
return 404;
}
location ~ /media/conversation_message_attachment_(files|previews|thumbnails)/ {
deny all;
return 404;
}
location /uploads/ {
internal;
alias ${FILE_UPLOAD_DIR};
etag on;
}
location /community_proxy/ {
proxy_pass https://community.karrot.world/;
}
error_page 503 @maintenance;
location @maintenance {
try_files /maintenance.html =503;
}
}

View File

@@ -78,11 +78,11 @@ spec:
limits:
cpu: "2"
ephemeral-storage: 1Gi
memory: 4Gi
memory: 6Gi
requests:
cpu: 50m
ephemeral-storage: 50Mi
memory: 256Mi
memory: 512Mi
volumeMounts:
- name: pretix-data
mountPath: /data