Resources and chart values
API
The API group is strait.tako.id, served as v1. v1alpha1 is still served, deprecated, with the same schema. A change that breaks a user comes as a new API version. The versions and how they are stored are in RFC0001, API versions. Moving objects from v1alpha1 to v1 is in Upgrade.
Resources
Every resource, its scope and the RFC that owns it are in RFC0001, Resources. Each site has one Site, one SitePeer per peer and one SiteLink per path, and one SiteService per application name.
| To read | Where |
|---|---|
| Every field, with its description | kubectl --context SITE explain siteservice.spec, or any other kind and field path. The Go types are in api/v1/. |
| The CRDs | strait-crds.yaml in each release, generated into config/crd/. |
A SiteService and how it routes | Concepts and RFC0002. |
| A plugin's fields | RFC0003. |
Site, SitePeer, SiteLink, Export and Import | RFC0005. |
| Checking manifests before applying them | strait validate -f PATH (The strait command). |
Chart values
Every value of the chart, with its comment, is in values.yaml. Its top-level keys:
| Key | Sets |
|---|---|
image | Which image the chart runs (Install). |
envoy | The gateway's Envoy. |
controller | The controller's Deployment. Its memory: Sizing the controller. |
gateway | The gateway's Deployment, its replicas and its disruption budget. |
site | The local Site that the chart renders. |
cnpg | The cnpg plugin's access to CloudNativePG. |
metrics | Scraping and alert rules (Metrics and alerts). |
networkPolicy | The NetworkPolicies of the controller and the gateway (RFC0007). |