Skip to content

Repository files navigation

snowplow

The content API of Krateo PlatformOps: it resolves RESTAction and frontend Widget custom resources into the JSON the Krateo portal renders, served over GET /call.

What is this

A content bridge, not a BFF: snowplow holds no product state — it composes portal content on demand from Kubernetes CRs (declarative REST-call chains, widget definitions), enforces the caller's own RBAC, and serves any client that presents a Krateo JWT. One monorepo, one version line: the app (go/snowplow/) and its Helm charts (helm/) ship together from a single tag. Full picture: docs/index.md.

Install

Normally installed by the Krateo installer, which pins the chart. Standalone:

# CRDs first (RESTAction + the authn ServiceAccount CRD the app chart hard-requires):
helm install snowplow-crds oci://ghcr.io/krateo-platformops/charts/snowplow-crds --version 1.9.0
helm install authn-crds oci://ghcr.io/krateo-platformops/charts/authn-crds

helm install snowplow oci://ghcr.io/krateo-platformops/charts/snowplow \
  --version 1.9.0 --namespace krateo-system

Details, dependencies and the Kind quickstart: docs/usage.md.

Configure

See docs/configuration.md. Most used:

Setting Default Effect
env.CACHE_ENABLED "true" The single cache master gate; false = transparent direct-apiserver fallback (same data, slower).
env.GOMEMLIMIT 7GiB Go GC back-pressure ceiling — must stay strictly below resources.limits.memory (8Gi) or Linux OOM-kills instead.
service.type / service.port LoadBalancer / 8081 One port serves content, probes and debug surfaces.

Examples

Docs

Internals (code-traced): go/snowplow/ARCHITECTURE.md and the deep dives it links.

Develop & release

cd go/snowplow && go test ./... (keep KUBECONFIG unset — see CONTRIBUTING); local cluster workflow via go/snowplow/scripts/. Tag X.Y.Z (no v) ships image + charts — release runbook: docs/release.md.

About

Krateo PlatformOps snowplow — the portal content/composition API the frontend SPA calls for navmenus, routes, pages and panels. Packaged by krateo-snowplow-chart.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages