mirror of
https://github.com/sredevopsorg/deepseek-kubernetes-sandbox.git
synced 2026-11-03 01:13:24 +00:00
bf24306421
Add the project-local dsh-agent-sandbox-platform skill covering platform operations, the optional agent-sandbox MCP server, feature-extension recipes, and a read-only preflight. Document project skills in README, docs and AGENTS.md. Co-authored-by: SREDevOpsAgents <agents@sredevops.org>
3.0 KiB
3.0 KiB
Repository documentation
Repository-wide documentation lives here. Example-specific material lives with
its example under examples/<name>/docs/ — see the
agents-as-a-service architecture
for the deep-dive that used to live in this directory.
If you are new, read the root README first: it is image-first and gets a DSH Web container running before anything else.
Index
| Document | Read it for |
|---|---|
| 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 | The example contract: required layout, manifest rules, exposure variants, components and image naming, scripts, docs, and how to add a new example. |
| 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 | Release identity (DSH ref + optional -rN), why the current identity is dsh-v0.2.1-rc.3-r3, 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 | 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 | The index of implementations in this repository. |
| dsh-agents-as-a-service README | The multi-tenant platform walkthrough: warm pool, claims, suspend/resume, gateway, exposure and troubleshooting. |
| dsh-agents-as-a-service architecture | Container/sequence diagrams, ADRs, security and RBAC, failure modes and the evolution path. |
| gateway README | The gateway's HTTP/WebSocket API, configuration, auth (including SSO), and limitations. |
Project policies
| Document | Read it for |
|---|---|
| AGENTS.md | Repository conventions for AI agents and humans, and the commands the CI runs. |
| CONTRIBUTING.md | Local setup, the change workflow and what a pull request needs. |
| SECURITY.md | Vulnerability reporting and project-specific threat notes (pod logs, SSO header trust, shared provider key, TLS). |
| CODE_OF_CONDUCT.md | Community standards. |
| CHANGELOG.md | Generated release history (do not edit by hand). |
| LICENSE | MIT. |