-
Notifications
You must be signed in to change notification settings - Fork 30
Description
Issue Description
The documentation does a great job covering the individual steps and options required to deploy a production‑grade AGNTCY Directory node with federation enabled (see https://github.com/agntcy/docs/tree/main/docs/dir). The available guides highlight multiple deployment paths and trade‑offs, which is valuable for experienced users.
However, the documentation is spread across multiple documents that reference each other. While this provides flexibility and depth, it can be overwhelming for newcomers—especially users without Kubernetes or cloud infrastructure experience—who want to perform their first production‑level deployment. Also from document to document sometimes there as minor "piping" steps not defined that require a person with previous experience with kubernetes and deployment technologies to fill the gap.
Prposed Solution
Provide one or more end‑to‑end deployment guides that focus on a clear “happy path” for a production‑ready Directory deployment, aiming for as much out‑of‑the‑box automation as possible. For example:
- A single, opinionated, “for‑dummies” style document covering:
- At least one major cloud provider (AWS, Azure, or GCP)
- One on‑prem / self‑hosted alternative
2.Optional enhancements to automation assets (Terraform, Helm values, shell scripts, etc.) to minimize manual steps. For cloud providers, this could include scripts that combine vendor‑specific infrastructure provisioning with the Kubernetes deployment workflow.
I acknowledge that fully automated or long‑lived guides may become outdated over time. Even so, having a reference end‑to‑end path would significantly lower the barrier for early adopters and first‑time users, and make initial production deployments more approachable.
Affected Component
Directory
Checklist
- I have read the contributing guidelines.
- I have verified this does not duplicate an existing issue.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status