docs: Add comprehensive AWS EKS deployment guide#297
docs: Add comprehensive AWS EKS deployment guide#297hossain-rayhan wants to merge 1 commit intodocumentdb:mainfrom
Conversation
Signed-off-by: Rayhan Hossain <rhossain@microsoft.com>
There was a problem hiding this comment.
Pull request overview
Adds a new “Deploy on AWS EKS” getting-started guide to the public preview documentation and updates the MkDocs configuration to support code annotations and Mermaid diagrams.
Changes:
- Added a comprehensive AWS EKS deployment guide (quick-start via playground scripts + manual steps).
- Updated
mkdocs.ymlnavigation to include the new Getting Started section. - Enabled MkDocs Material features and markdown extensions for code annotations, syntax highlighting, and Mermaid fences, and added Mermaid JS loading.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| mkdocs.yml | Adds nav entry for the EKS guide; enables code annotations + pymdownx extensions; loads Mermaid JS. |
| docs/operator-public-documentation/preview/getting-started/deploy-on-eks.md | New end-to-end EKS deployment guide with architecture diagram, step-by-step instructions, and troubleshooting. |
| | eksctl | 0.160+ | EKS cluster creation and management | [Install eksctl](https://eksctl.io/installation/) | | ||
| | kubectl | 1.28+ | Kubernetes cluster interaction | [Install kubectl](https://kubernetes.io/docs/tasks/tools/) | | ||
| | Helm | 3.x | Package management for Kubernetes | [Install Helm](https://helm.sh/docs/intro/install/) | |
There was a problem hiding this comment.
The prerequisites list kubectl 1.28+, but the operator docs require a Kubernetes 1.35+ cluster (ImageVolume GA) and kubectl should generally match the cluster minor version. Consider updating this guide to explicitly require EKS/Kubernetes 1.35+ (and adjust the kubectl version accordingly), and optionally show eksctl create cluster --version ... so readers don’t end up with an unsupported EKS version.
| # Install the operator | ||
| helm install documentdb-operator \ | ||
| oci://ghcr.io/documentdb/documentdb-operator \ | ||
| --version 0.1.0 \ | ||
| --namespace documentdb-operator \ | ||
| --create-namespace \ | ||
| --wait |
There was a problem hiding this comment.
The Helm install example pins --version 0.1.0, but the Helm chart in this repo is currently version 0.1.3. Pinning an older version here is likely to install an outdated operator (or fail if 0.1.0 isn’t published). Please update the guide to use the current chart version (or explain how to discover the latest published version).
| --region $REGION \ | ||
| --node-type t3.medium \ # Smaller instance type | ||
| --nodes 2 |
There was a problem hiding this comment.
This eksctl example uses a line-continuation backslash followed by an inline comment (--node-type t3.medium \ # ...). Because the backslash isn’t the last character on the line, copying this command into a shell will break. Move the comment to its own line or keep the \ as the final character.
| echo "Connection string: mongodb://docdbadmin:YourSecurePassword123!@${EXTERNAL_IP}:10260/" | ||
| ``` | ||
|
|
||
| ### Test Connection | ||
|
|
||
| ```bash | ||
| # Using mongosh (if installed) | ||
| mongosh "mongodb://docdbadmin:YourSecurePassword123!@${EXTERNAL_IP}:10260/" | ||
|
|
There was a problem hiding this comment.
The example password includes ! and is later embedded inside double-quoted strings (e.g., the echo and mongosh "mongodb://..." commands). In interactive bash, ! triggers history expansion and can cause event not found errors when users paste these commands. Consider either using a password without ! in the examples, escaping it, or wrapping the connection string in single quotes.
| extra_javascript: | ||
| - https://unpkg.com/mermaid@10/dist/mermaid.min.js |
There was a problem hiding this comment.
extra_javascript pulls Mermaid from an external CDN (unpkg.com). This introduces a supply-chain/availability dependency for the rendered docs site (and may be disallowed in some environments). Consider vendoring a pinned Mermaid asset in the repo (or another trusted hosting approach) instead of loading it at runtime from a third-party CDN.
Summary
Adds a comprehensive deployment guide for DocumentDB on AWS EKS, following the documentation improvement plan (Phase 1.6).
Changes
New Files
docs/operator-public-documentation/preview/getting-started/deploy-on-eks.md- Complete EKS deployment guideUpdated Files
mkdocs.yml- Added Getting Started navigation section and enabled Material theme features:content.code.annotate)pymdownx.superfencespymdownx.highlightDocumentation Highlights
References
documentdb-playground/aws-setup/