mirror of
https://github.com/sredevopsorg/deepseek-kubernetes-sandbox.git
synced 2026-11-03 01:13:24 +00:00
24f23e09ae
Remove obsolete layout/migration prose and legacy gateway-alias references, reconcile the required-check policy, fix version-label/RBAC/workspace/channel drift, and de-duplicate the example and gateway docs. Rename the minimal manifest to 10-sandboxtemplate.yaml and mount the dsh-home PVC's workspace subPath at /workspace so the documented persistence is real. Enforce numbered top-level manifests in check-examples.sh. Verified with make check, yamllint, shellcheck, a Markdown link/anchor scan, and git diff --check. Co-authored-by: SREDevOpsAgents <agents@sredevops.org>
49 lines
3.3 KiB
Markdown
49 lines
3.3 KiB
Markdown
# Repository documentation
|
|
|
|
Repository-wide documentation lives here. Example-specific material lives with
|
|
its example under [`examples/<name>/docs/`](../examples/) — see the
|
|
[agents-as-a-service architecture](../examples/dsh-agents-as-a-service/docs/architecture.md).
|
|
|
|
If you are new, read the [root README](../README.md) first: it is image-first and
|
|
gets a DSH Web container running before anything else.
|
|
|
|
## Index
|
|
|
|
| Document | Read it for |
|
|
| --- | --- |
|
|
| [main-image.md](main-image.md) | The primary artifact: build args, runtime environment, entrypoint, probes, volumes/ports/signals, non-root contract, image names, tags and digests. |
|
|
| [examples.md](examples.md) | The example contract: required layout, manifest rules, exposure variants, components and image naming, scripts, docs, and how to add a new example. |
|
|
| [gitflow.md](gitflow.md) | Branches, protected `main`, squash merges, Conventional PR titles, required CI checks, release branches, hotfixes and the one-time GitHub settings checklist. |
|
|
| [versioning.md](versioning.md) | Release identity (`DSH ref` + optional `-rN`), the current identity `dsh-v0.2.1-rc.5`, why identities are immutable, channels, compatibility matrix, bumping pins, the release checklist, rollback, git-cliff and digest pinning. |
|
|
|
|
## Project skills
|
|
|
|
DSH discovers project skills from `<git root>/.dsh/skills/<name>/SKILL.md`
|
|
(the nearest `.git` ancestor). This repository ships one:
|
|
|
|
| Skill | Read it for |
|
|
| --- | --- |
|
|
| [dsh-agent-sandbox-platform](../.dsh/skills/dsh-agent-sandbox-platform/SKILL.md) | Operating and extending the agents-as-a-service platform, agent-sandbox MCP limits and deployment, and a read-only preflight. |
|
|
|
|
## Example documentation
|
|
|
|
| Document | Read it for |
|
|
| --- | --- |
|
|
| [examples/README.md](../examples/README.md) | The index of implementations in this repository. |
|
|
| [dsh-agents-as-a-service README](../examples/dsh-agents-as-a-service/README.md) | The multi-tenant platform walkthrough: warm pool, claims, suspend/resume, gateway, exposure and troubleshooting. |
|
|
| [dsh-agents-as-a-service architecture](../examples/dsh-agents-as-a-service/docs/architecture.md) | Container/sequence diagrams, ADRs, security and RBAC, failure modes and the evolution path. |
|
|
| [gateway README](../examples/dsh-agents-as-a-service/gateway/README.md) | The gateway's HTTP/WebSocket API, configuration, auth (including SSO), and limitations. |
|
|
| [optional hardening](../examples/dsh-agents-as-a-service/docs/optional-hardening.md) | Opt-in gVisor, nodeSelector, NetworkPolicy, provider keys and failed-Pod recovery. |
|
|
| [exposure variants](../examples/dsh-agents-as-a-service/manifests/exposure/README.md) | The mutually exclusive Ingress and Gateway API + SSO exposure paths. |
|
|
|
|
## Project policies
|
|
|
|
| Document | Read it for |
|
|
| --- | --- |
|
|
| [AGENTS.md](../AGENTS.md) | Repository conventions for AI agents and humans, and the commands the CI runs. |
|
|
| [CONTRIBUTING.md](../CONTRIBUTING.md) | Local setup, the change workflow and what a pull request needs. |
|
|
| [SECURITY.md](../SECURITY.md) | Vulnerability reporting and project-specific threat notes (pod logs, SSO header trust, shared provider key, TLS). |
|
|
| [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) | Community standards. |
|
|
| [CHANGELOG.md](../CHANGELOG.md) | Generated release history (do not edit by hand). |
|
|
| [LICENSE](../LICENSE) | MIT. |
|