Skip to content

Commit 007a2ee

Browse files
kernel-gdclaude
andcommitted
docs: clarify published-artifact install path across README and onboarding
Make it explicit that partners do not need to clone the repo to install Koshi. The canonical path is the published OCI Helm chart and container image; the local demo is scoped to development/validation only. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 8fab642 commit 007a2ee

3 files changed

Lines changed: 8 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Koshi Runtime is a workload-scoped governance plane for AI systems. It deploys a
44

55
**Discover your governance posture before enforcing it.** Koshi ships in **listener mode** by default: the full enforcement pipeline — identity resolution, policy lookup, guard evaluation, budget accounting — executes on every request, but no traffic is blocked. Shadow decisions (`would_reject`, `would_throttle`, `would_kill`) reveal exactly where your policies would intervene. When the posture matches your intent, enabling enforcement is a config change — same binary, same pipeline, same metrics.
66

7+
**No repo clone required.** Install Koshi directly from the published OCI Helm chart and container image.
8+
79
## Quick Start: Kubernetes (Listener Mode)
810

911
```bash
@@ -28,7 +30,7 @@ curl http://localhost:15080/metrics | grep koshi_listener
2830

2931
### What You Can Do on Day One
3032

31-
- Install Koshi in listener mode — one Helm command, no config files required
33+
- Install Koshi in listener mode — one Helm command, no repo clone or config files required
3234
- Label any namespace and restart workloads to get sidecars injected
3335
- Collect structured JSON events from `koshi-listener` container logs
3436
- Scrape Prometheus metrics from `/metrics` on port `15080`

demo/local/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This demo creates a local Kubernetes cluster with kind, installs Koshi in listener mode, deploys a mock upstream and sample workload, sends synthetic traffic, and validates structured events and metrics.
44

5-
> **For partner onboarding on a real cluster**, see [Koshi Onboarding](../../docs/onboarding.md). This demo is for local development and validation only.
5+
> **This demo is for local development and validation only.** It requires a repo checkout, a local Docker build, and a kind cluster. To install Koshi on a real cluster using published artifacts, see [Koshi Onboarding](../../docs/onboarding.md).
66
77
## Prerequisites
88

docs/onboarding.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This guide walks through installing Koshi in listener mode, verifying the sidecar is active, collecting governance signal, and interpreting shadow outcomes — all without blocking any traffic.
44

5+
This flow uses published release artifacts. No local repo checkout is required.
6+
57
## Install
68

79
```bash
@@ -16,6 +18,8 @@ kubectl label namespace <namespace> runtime.getkoshi.ai/inject=true
1618
kubectl rollout restart deployment -n <namespace>
1719
```
1820

21+
> The default image is `ghcr.io/koshihq/koshi-runtime`. To use the Docker Hub mirror, add `--set image.repository=docker.io/koshihq/koshi-runtime`.
22+
1923
## Verify
2024

2125
**Confirm the sidecar is injected:**

0 commit comments

Comments
 (0)