[PR #175] [MERGED] docs(deploy): clarify gateway ports and shared storage requirements

bsakaguchi commented

2026-10-29 14:21:16 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/AgentENV/pull/175
Author: @zlzGithub-0801
Created: 8/17/2026
Status: ✅ Merged
Merged: 8/18/2026
Merged by: @yingdi-shan

Base: main ← Head: docs/deployment-ports-and-storage-docs

📝 Commits (1)

71e74e6 docs(deploy): clarify gateway ports and shared storage requirements

📊 Changes

7 files changed (+17 additions, -26 deletions)

View changed files

📝 deploy/docker-compose.yml (+1 -7)
📝 docs/src/deployment/docker-compose.md (+5 -14)
📝 docs/src/deployment/kubernetes.md (+1 -0)
📝 docs/src/deployment/manual-compile.md (+1 -1)
📝 docs/src/deployment/static-multi-node.md (+2 -1)
📝 scripts/tests/e2e/docker-compose.e2e.yml (+6 -2)
📝 scripts/tests/e2e/lib/runtime.sh (+1 -1)

📄 Description

What

Improve deployment documentation and adjust the Docker Compose gateway port.

Why

The existing deployment documentation is incomplete.

N/A

Scope and non-goals

Included:

documentation updates
exposed port updates

Excluded:

Changes to AgentENV's internal behavior

Design and behavior changes

N/A

Compatibility and operations

Public API or generated protocol: No changes
Configuration or defaults: The Docker Compose gateway is exposed on port 8000
Snapshot manifest, artifact layout, or storage format: No changes
Upgrade and rollback: No changes
Host requirements, permissions, ports, or dependencies: No changes

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:

Other tests were skipped because this change does not affect the relevant components.

Risks and reviewer notes

After make deploy-up, the gateway is available on host port 8000.

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/175 **Author:** [@zlzGithub-0801](https://github.com/zlzGithub-0801) **Created:** 8/17/2026 **Status:** ✅ Merged **Merged:** 8/18/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/deployment-ports-and-storage-docs` --- ### 📝 Commits (1) - [`71e74e6`](https://github.com/kvcache-ai/AgentENV/commit/71e74e65f4126a438d0f1f28b9d39f182dae6218) docs(deploy): clarify gateway ports and shared storage requirements ### 📊 Changes **7 files changed** (+17 additions, -26 deletions) <details> <summary>View changed files</summary> 📝 `deploy/docker-compose.yml` (+1 -7) 📝 `docs/src/deployment/docker-compose.md` (+5 -14) 📝 `docs/src/deployment/kubernetes.md` (+1 -0) 📝 `docs/src/deployment/manual-compile.md` (+1 -1) 📝 `docs/src/deployment/static-multi-node.md` (+2 -1) 📝 `scripts/tests/e2e/docker-compose.e2e.yml` (+6 -2) 📝 `scripts/tests/e2e/lib/runtime.sh` (+1 -1) </details> ### 📄 Description ## What Improve deployment documentation and adjust the Docker Compose gateway port. ## Why The existing deployment documentation is incomplete. ## Related issue N/A ## Scope and non-goals Included: - documentation updates - exposed port updates Excluded: - Changes to AgentENV's internal behavior ## Design and behavior changes N/A ## Compatibility and operations - Public API or generated protocol: No changes - Configuration or defaults: The Docker Compose gateway is exposed on port 8000 - Snapshot manifest, artifact layout, or storage format: No changes - Upgrade and rollback: No changes - Host requirements, permissions, ports, or dependencies: No changes ## Validation - [x] `make fmt` - [x] `make clippy` - [x] `make test-unit` - [x] Relevant Rust integration tests - [ ] `make -C services test` (required when `services/` changes) - [x] Generated clients/server regenerated with the documented `make` target - [x] Documentation updated - [ ] Benchmarks or performance comparison completed Skipped checks and reasons: - Other tests were skipped because this change does not affect the relevant components. ## Risks and reviewer notes  After `make deploy-up`, the gateway is available on host port 8000. ## 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