- TypeScript 100%
|
All checks were successful
CI / CI (push) Successful in 49s
Reviewed-on: #14 |
||
|---|---|---|
| .forgejo/workflows | ||
| .tycho | ||
| bin | ||
| k8s | ||
| .gitignore | ||
| .gitleaks.toml | ||
| AGENTS.md | ||
| CLAUDE.md | ||
| LICENSE | ||
| package.json | ||
| README.fr.md | ||
| README.md | ||
Tycho Catalogue
Official catalogue of Tycho recipes: provider-agnostic Kubernetes recipes for popular services whose publishers do not ship a Tycho recipe (Traefik, cert-manager, Forgejo, Keycloak, Discourse, ChirpStack…).
The catalogue holds no instance value and no secret. Every hostname, e-mail, IP or identifier of a deployment is a ${VARIABLE} placeholder declared in .tycho/repository.json; its value belongs to the operator's private target repository (<org>/<engine>-<provider>-<target>, Tycho RFC-001).
Recipes
| Recipe | Layer | Path | Components |
|---|---|---|---|
common |
foundation | k8s/common |
scaleway (SBS StorageClasses) |
traefik |
foundation | k8s/traefik/base |
scaleway (load balancer binding), dashboard, default-certificate |
cert-manager |
foundation | k8s/cert-manager/base |
— |
reloader |
platform | k8s/reloader |
— |
mail |
platform | k8s/stacks/mail/base |
— |
keycloak |
platform | k8s/stacks/keycloak/base |
realm-import, theme |
forgejo |
platform | k8s/stacks/forgejo/base |
registry-host, apex-packages; option actions-runner |
forgejo-runner |
platform | k8s/stacks/forgejo-runner/base |
auto-register |
keda |
platform | k8s/stacks/keda/base |
— |
turbo-cache |
platform | k8s/stacks/turbo-cache/base |
— |
modaka-studio |
application | k8s/stacks/modaka-studio/base |
oidc, database-network-policy |
Each recipe is described by .tycho/recipes/k8s/<recipe>/package.json (variables, requirements, routes, secrets, data, components); see .tycho/README.md.
Using a recipe from a target repository
Reference a released version, never a branch:
# targets/<target>/stacks/traefik/kustomization.yml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- https://git.qtrn.io/tycho/catalog//k8s/traefik/base?ref=v1.0.0
components:
- https://git.qtrn.io/tycho/catalog//k8s/traefik/providers/scaleway?ref=v1.0.0
patches:
# values of the target (until `tycho render` substitutes the placeholders)
- target: { kind: Service, name: traefik }
patch: |-
- { op: replace, path: /spec/loadBalancerIP, value: "203.0.113.10" }
Contributing
- A recipe never contains a value of one deployment: use a
${VARIABLE}declared in.tycho/repository.json, and an optional component for anything a target may not want. bun run validatebuilds every recipe alone and with each component, and rejects instance hostnames, e-mails and IPs.- GitFlow: branch from
develop, pull request todevelop; releases are pull requestsdevelop→main, taggedvX.Y.Z.
License
Forgejo option actions-runner
Enabling it installs keda and forgejo-runner with the component auto-register: a Job generates the instance runner registration token and an admin token with scope read:admin for the KEDA scaler (service account ci-autoscaler), then writes the Secret forgejo-runner-secret. Nothing to copy from the web UI; delete the Secret to rotate both tokens. Runners are ephemeral Jobs on the dedicated, scale-to-zero runner pool (node label and taint workload=ci-runner).