Skip to content

docs: Helm chart reference, MongoDB Operator guide, and K8s install rework#3010

Merged
wyattwalter merged 11 commits into
mainfrom
claude/thirsty-almeida-9daaf9
May 21, 2026
Merged

docs: Helm chart reference, MongoDB Operator guide, and K8s install rework#3010
wyattwalter merged 11 commits into
mainfrom
claude/thirsty-almeida-9daaf9

Conversation

@wyattwalter
Copy link
Copy Markdown
Contributor

@wyattwalter wyattwalter commented May 14, 2026

Summary

  • New page: Helm Chart reference — deployment planning decisions (storage/workload type, MongoDB, Redis, PostgreSQL), community edition config, and values reference link
  • New page: MongoDB Kubernetes Operator — fresh install walkthrough, configuration (password management, production sizing, ArgoCD), migration from Bitnami subchart, uninstall with finalizer handling, troubleshooting
  • Reworked Kubernetes install guide — rewritten intro, specific resource requirements, MongoDB Operator as default, ingress in values.yaml, pinned image version, streamlined next steps

Remaining work

  • Rework the expose/ingress page — rename from "Expose K8s to Internet" to focus on TLS/cert-manager configuration, replace dead ingress-nginx references
  • Revisit sidebar IA / menu structure
  • Review MongoDB Kubernetes Operator page content
  • Add uninstall section to the Helm Chart reference page

Test plan

  • Verify new pages render at /getting-started/setup/instance-configuration/helm-chart and /getting-started/setup/instance-configuration/mongodb-kubernetes-operator
  • Verify both appear in sidebar under Reference
  • Verify Kubernetes install page intro, requirements, install steps, and next steps cards
  • Check all internal links resolve (no broken links)
  • Review values.yaml example in install guide against current chart defaults

🤖 Generated with Claude Code

…bernetes install page

Add two new documentation pages and significantly rework the Kubernetes
installation guide to reflect current best practices.

New pages:
- Helm Chart reference covering deployment planning decisions (storage,
  workload type, MongoDB, Redis, PostgreSQL) and community edition config
- MongoDB Kubernetes Operator guide with install, configuration, migration
  from Bitnami, and troubleshooting

Kubernetes install guide changes:
- Rewrite intro with deployment planning link and HA guidance
- Replace vague system requirements with specific resource breakdown
- Remove outdated video embed
- Add MongoDB Operator and ingress config to default values.yaml
- Pin image version instead of using latest tag
- Remove separate Community edition section (moved to Helm Chart page)
- Rename "Post-installation configuration" to "Next steps"
- Add TLS and uninstall cards to next steps

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
appsmith-docs Ready Ready Preview, Comment May 20, 2026 4:22pm

Request Review

The Google style guide rule [Google.EmDash] requires em dashes without
surrounding spaces.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the outdated "Expose K8s to Internet" page with a focused TLS
guide. Ingress setup moved into the install guide; this page now covers
TLS termination options: wildcard certs, cert-manager, bring your own,
and controller-managed TLS.

Adds a warning against using APPSMITH_CUSTOM_DOMAIN on Kubernetes and
removes references to the dead ingress.selfSigned option.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
wyattwalter and others added 2 commits May 18, 2026 16:43
Links to the MongoDB Operator page for operator-aware uninstall and
provides inline steps for Bitnami/external MongoDB. Updates the
uninstall card on the install page to deep-link to the new section.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Replace inline fresh install steps with link to install guide
- Remove ArgoCD example (belongs on Helm Chart page if needed)
- Reorder migration to expand-move-contract pattern
- Add HA scale-down instructions for Deployment workloads
- Simplify data migration to dump/restore from single pod
- Move Uninstall section after Migration, before Troubleshooting
- Update all references to use appsmith-ee namespace and release name
- Fix namespace typos in uninstall and troubleshooting sections
- Bump minimum K8s version to 1.33+

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Move Helm Chart, MongoDB Operator, and Ingress/TLS pages into a
dedicated "Helm Chart" category under Manage Installation. Add
external database links, storage expansion callout, and update
cross-references to use new page titles.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@wyattwalter wyattwalter marked this pull request as ready for review May 19, 2026 20:05
Delete configure-tls.mdx (outdated, referenced ingress-nginx and
cert-manager v1.5.3) and repoint the three migration guides that
linked to it to the new Ingress and TLS page.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Use placeholder values (<APPSMITH_VERSION>, <INGRESS_CLASS>) that
  break YAML parsing if not replaced, with inline comments explaining
  how to find the correct values
- Add ingress verification step (kubectl get ingress) before DNS/
  port-forward step
- Use svc/appsmith-ee for port-forward instead of pod name
- Update Helm prerequisite to note Helm 4 support
- Soften allowVolumeExpansion to a recommendation
- Clarify prose to distinguish MongoDB config from ingress config

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
wyattwalter and others added 2 commits May 20, 2026 11:19
- Run mongodump/mongorestore from operator pod (Bitnami image lacks
  the database tools)
- Use operator's connection secret for DEST_URI instead of
  hand-constructed URI
- Add explicit PHASE=Running gate before proceeding past step 1
- Add pod termination verification command to step 2
- Clarify step 4 describes connection rewiring
- Add backup recommendation before starting migration

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@wyattwalter wyattwalter merged commit 90c50a9 into main May 21, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants