docs: add Kubernetes deployment guide with ArgoCD and Flux CD#816
docs: add Kubernetes deployment guide with ArgoCD and Flux CD#816officialasishkumar wants to merge 28 commits intomainfrom
Conversation
Code Review SummaryStatus: No New Issues | Recommendation: Merge Incremental ReviewReviewed changes since commit Changes in This Commit
Previous Issues - All ResolvedAll inline comments from previous reviews have been addressed:
Files Reviewed (1 file in incremental diff)
Full PR Files (8 files)
Reviewed by claude-4.5-opus-20251124 · 89,805 tokens |
There was a problem hiding this comment.
Pull request overview
This PR updates the v4.0.0 documentation to provide a unified Kubernetes deployment guide (including Kind + GitOps flows) and restructures the Installation section in the sidebar into Local / Enterprise / Kubernetes entries.
Changes:
- Restructures the v4.0.0 sidebar “Installation” entry into a collapsible category with “Local”, “Enterprise”, and “Kubernetes”.
- Adds a new combined Kubernetes setup page covering Kind, Helm connect, TLS passthrough with Contour, and GitOps deployment via ArgoCD + Flux CD.
- Renames installation doc sidebar labels to match the new Installation grouping (“Local”, “Enterprise”).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_sidebars/version-4.0.0-sidebars.json | Converts Installation into a category and points to Local/Enterprise/Kubernetes docs. |
| versioned_docs/version-4.0.0/server/installation.md | Updates sidebar label to “Local”. |
| versioned_docs/version-4.0.0/keploy-cloud/installation.md | Updates sidebar label to “Enterprise”. |
| versioned_docs/version-4.0.0/keploy-cloud/kubernetes.md | Adds the unified Kubernetes guide (Kind + Contour TLS passthrough + ArgoCD + Flux). |
| versioned_docs/version-4.0.0/keploy-cloud/gitops-argocd.md | Adds an ArgoCD-focused GitOps guide for k8s-proxy. |
| versioned_docs/version-4.0.0/keploy-cloud/gitops-flux.md | Adds a Flux-focused GitOps guide for k8s-proxy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Group Installation, Enterprise Installation, and Kubernetes under a collapsible Installation category. Add GitOps Deployment subcategory under Kubernetes with ArgoCD and Flux placeholders. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Covers Contour ingress with TLS passthrough, ArgoCD Application template, HTTPProxy setup, and step-by-step verification. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Covers Flux bootstrap, HelmRepository source, HelmRelease config, Contour HTTPProxy with TLS passthrough, and verification steps. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
…llation Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Updated the keploy-argocd-demo repo link description to mention the new flux/ directory with ready-to-use staging and production manifests. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
…n page - Merged kubernetes-local-setup, gitops-argocd, and gitops-flux into one combined kubernetes.md page under Installation. - Renamed "Keploy OSS" to "Local" and "Enterprise Installation" to "Enterprise" in the sidebar. - Removed separate Kubernetes sidebar category; it now lives as a single doc inside Installation alongside Local and Enterprise. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Fixed sidebar doc ID reference (server/install) so label override works. - Sidebar now shows "Local", "Enterprise", "Kubernetes" under Installation. - Promoted ArgoCD and Flux CD sections to h2 headings so they appear as top-level TOC entries instead of being hidden under GitOps Deployment. - Renamed "Option A/B" to "Deploy with ArgoCD/Flux CD" since they are standalone guides, not alternatives. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Changed demo repo link from keploy-argocd-demo to keploy-k8s-demo which contains both ArgoCD and Flux CD manifests with a README. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Auto-formatted markdown tables and line wrapping in gitops-argocd, gitops-flux, and kubernetes pages to pass prettier CI check. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Removed Prerequisites sections from ArgoCD and Flux CD guides since the guide itself covers installation inline. - Made Contour optional — k8s-proxy works with any TLS passthrough ingress controller or direct NodePort/LoadBalancer. - Reframed Contour section as one example, not a requirement. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Already covered in the local setup section (step 2). Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- The tables just repeated what the guide already covered. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Not Keploy-specific, just Envoy/Contour internals. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Developers know where they put their files. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Not Keploy-specific. Users already have ArgoCD/Flux installed or can follow their own docs for setup. - Keep only the Keploy-specific manifests and steps. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
…des" This reverts commit beb5f1a. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
* docs: fix MCP type to http, add recording tools and workflow - Fix Claude Code config: type "url" → type "http" (StreamableHTTP) - Add 4 new recording/schema tools to the tools table (43+ total) - Add "Using Recorded Traffic for Better Tests" section with agent workflow - Update tool count from 39+ to 43+ Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: slayerjain <shubhamkjain@outlook.com> * fix: run prettier on agent-test-generation.md Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: slayerjain <shubhamkjain@outlook.com> * fix: wrap k8s-proxy in backticks to fix Vale spelling lint Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: slayerjain <shubhamkjain@outlook.com> --------- Signed-off-by: slayerjain <shubhamkjain@outlook.com> Co-authored-by: slayerjain <shubhamkjain@outlook.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Fixed broken `#how-tls-passthrough-works` link in Flux CD section to point to the correct `#ingress-with-tls-passthrough-optional` anchor. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
b7913af to
119251b
Compare
- Added technical terms (kubectl, namespace, passthrough, HTTPProxy, Traefik, HAProxy, hostname, repo, etc.) to Vale vocabulary accept list. - Fixed em dash spacing (` — ` → `—`) to satisfy Google.EmDash rule. - Wrapped bare `k8s-proxy` references in backticks to avoid false Google.Units matches on `8s`. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
119251b to
64a445f
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| { | ||
| "type": "doc", | ||
| "label": "Local", | ||
| "id": "server/install" |
There was a problem hiding this comment.
The sidebar now points the "Local" Installation entry to server/install, but a number of existing docs link users to /docs/server/installation/ (the server/installation doc id from installation_tabs.md). This creates two competing “installation” entry points and can confuse navigation/search. Consider switching the sidebar item back to server/installation (or updating/redirecting internal links so the sidebar target and existing links are consistent).
| "id": "server/install" | |
| "id": "server/installation" |
There was a problem hiding this comment.
the sidebar uses server/install which matches the frontmatter id: install in installation.md — this is correct. the broken links to /docs/server/installation/ in other files are a pre-existing issue not from this PR
- Updated Helm CLI example in section 2.2 to use canonical nested `keploy.accessKey`, `keploy.clusterName`, etc. instead of top-level keys, matching the chart's values.yaml schema and the GitOps sections. - Updated prerequisite links in gitops-argocd.md and gitops-flux.md from orphaned `/docs/keploy-cloud/kubernetes-local-setup` to the canonical `/docs/keploy-cloud/kubernetes` page. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Reverted section 2.2 Helm CLI example back to top-level accessKey, clusterName, etc. Both schemas work due to template fallback logic. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Added note that cloud clusters (EKS/GKE/AKS) should use :443 instead of :30080 in the ingressUrl, since :30080 is specific to NodePort/Kind setups. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Added fullnameOverride: "k8s-proxy" to all GitOps Helm values. Without this, the chart generates a service name like k8s-proxy-k8s-proxy-chart which breaks HTTPProxy routing to service k8s-proxy on port 8080. - Fixed stale kubernetes-local-setup links in standalone GitOps docs. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Added warning that manual Helm install and GitOps are mutually exclusive to prevent users from installing k8s-proxy twice. - Added secret creation step before GitOps sections since they use existingSecret instead of inline --set accessKey. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Added kubectl create namespace before secret creation so GitOps-only users don't hit a missing namespace error. - Added :30080 vs :443 note to ArgoCD and Flux Replace sections in kubernetes.md, matching the standalone GitOps docs. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Removed kubectl create namespace keploy since it's already created by the manual Helm install or by the GitOps syncPolicy createNamespace. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Summary
New sidebar structure
Files changed
versioned_sidebars/version-4.0.0-sidebars.json— sidebar restructure, label fixes, doc ID correctionversioned_docs/version-4.0.0/keploy-cloud/kubernetes.md— new combined Kubernetes page (local setup + ArgoCD + Flux CD)versioned_docs/version-4.0.0/keploy-cloud/gitops-argocd.md— original ArgoCD guide (content merged into kubernetes.md)versioned_docs/version-4.0.0/keploy-cloud/gitops-flux.md— original Flux CD guide (content merged into kubernetes.md)versioned_docs/version-4.0.0/server/installation.md— sidebar label changed to "Local"versioned_docs/version-4.0.0/keploy-cloud/installation.md— sidebar label changed to "Enterprise"Test plan
npm run buildpasses without errors