[PR #442] [MERGED] docs: expand deployment configuration reference and examples #439

Closed
opened 2026-10-29 14:23:26 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/AgentENV/pull/442
Author: @zlzGithub-0801
Created: 10/27/2026
Status: ✅ Merged
Merged: 10/28/2026
Merged by: @yingdi-shan

Base: main ← Head: docs/gateway-config


📝 Commits (1)

  • 96dafbb docs: expand deployment configuration reference and examples

📊 Changes

10 files changed (+303 additions, -13 deletions)

View changed files

📝 docs/src/SUMMARY.md (+2 -1)
📝 docs/src/concepts/snapshots/p2p.md (+1 -1)
➕ docs/src/configuration/control-plane-config.md (+262 -0)
📝 docs/src/configuration/reference.md (+1 -1)
📝 docs/src/deployment/docker-compose.md (+14 -7)
📝 docs/src/deployment/kubernetes.md (+16 -0)
📝 docs/src/deployment/manual-compile.md (+1 -1)
📝 docs/src/deployment/pvm.md (+3 -1)
📝 docs/src/deployment/static-multi-node.md (+2 -0)
📝 docs/src/getting-started/on-demand-loading.md (+1 -1)

📄 Description

What

Expand deployment documentation with Scheduler and Gateway configuration fields, HTTPS settings, and JSON examples.

Why

Existing guides explain how to start the deployment but lack configuration details for scheduling, resource limits, and HTTPS.

N/A

Scope and non-goals

Documentation only. No runtime, API, or default changes.

Design and behavior changes

Document existing configuration precedence, restart requirements, discovery modes, scheduling controls, and TLS options.

Compatibility and operations

  • Public API or generated protocol: N/A
  • Configuration or defaults: N/A
  • Snapshot manifest, artifact layout, or storage format: N/A
  • Upgrade and rollback: N/A
  • Host requirements, permissions, ports, or dependencies: N/A

Validation

  • make fmt
  • make clippy
  • make test-unit
  • Relevant Rust integration tests
  • make -C services test (required when services/ changes)
  • Generated clients/server regenerated with the documented make target
  • Documentation updated
  • Benchmarks or performance comparison completed

Skipped checks and reasons:

Code tests and benchmarks skipped because only documentation changed. Deployment examples were not executed.

Risks and reviewer notes

N/A

Checklist

  • The PR contains one coherent change and no unrelated formatting or refactoring.
  • New behavior is covered by tests, or I explained why testing is impractical.
  • Logs and examples contain no credentials, tokens, or private registry information.
  • I did not manually edit generated code without updating its source and regenerating it.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/kvcache-ai/AgentENV/pull/442 **Author:** [@zlzGithub-0801](https://github.com/zlzGithub-0801) **Created:** 10/27/2026 **Status:** ✅ Merged **Merged:** 10/28/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/gateway-config` --- ### 📝 Commits (1) - [`96dafbb`](https://github.com/kvcache-ai/AgentENV/commit/96dafbbd7bcc8cf6b110fcb932c41e88443c83f2) docs: expand deployment configuration reference and examples ### 📊 Changes **10 files changed** (+303 additions, -13 deletions) <details> <summary>View changed files</summary> 📝 `docs/src/SUMMARY.md` (+2 -1) 📝 `docs/src/concepts/snapshots/p2p.md` (+1 -1) ➕ `docs/src/configuration/control-plane-config.md` (+262 -0) 📝 `docs/src/configuration/reference.md` (+1 -1) 📝 `docs/src/deployment/docker-compose.md` (+14 -7) 📝 `docs/src/deployment/kubernetes.md` (+16 -0) 📝 `docs/src/deployment/manual-compile.md` (+1 -1) 📝 `docs/src/deployment/pvm.md` (+3 -1) 📝 `docs/src/deployment/static-multi-node.md` (+2 -0) 📝 `docs/src/getting-started/on-demand-loading.md` (+1 -1) </details> ### 📄 Description ## What Expand deployment documentation with Scheduler and Gateway configuration fields, HTTPS settings, and JSON examples. ## Why Existing guides explain how to start the deployment but lack configuration details for scheduling, resource limits, and HTTPS. ## Related issue N/A ## Scope and non-goals Documentation only. No runtime, API, or default changes. ## Design and behavior changes Document existing configuration precedence, restart requirements, discovery modes, scheduling controls, and TLS options. ## Compatibility and operations - Public API or generated protocol: N/A - Configuration or defaults: N/A - Snapshot manifest, artifact layout, or storage format: N/A - Upgrade and rollback: N/A - Host requirements, permissions, ports, or dependencies: N/A ## Validation - [ ] `make fmt` - [ ] `make clippy` - [ ] `make test-unit` - [ ] Relevant Rust integration tests - [ ] `make -C services test` (required when `services/` changes) - [ ] Generated clients/server regenerated with the documented `make` target - [x] Documentation updated - [ ] Benchmarks or performance comparison completed Skipped checks and reasons: Code tests and benchmarks skipped because only documentation changed. Deployment examples were not executed. ## Risks and reviewer notes N/A ## Checklist - [x] The PR contains one coherent change and no unrelated formatting or refactoring. - [x] New behavior is covered by tests, or I explained why testing is impractical. - [x] Logs and examples contain no credentials, tokens, or private registry information. - [x] I did not manually edit generated code without updating its source and regenerating it. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-29 14:23:26 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
kvcache-ai/AgentENV#439
No description provided.