Repository navigation
docs: point scripts and docs at operator 1.0.0 - #479
Open
guanzhousongmicrosoft wants to merge 1 commit into
Open
guanzhousongmicrosoft wants to merge 1 commit into
guanzhousongmicrosoft wants to merge 1 commit into
Conversation
guanzhousongmicrosoft
requested review from
WentingWu666666,
alaye-ms,
hossain-rayhan and
xgerman
as code owners
October 19, 2026 13:01
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The telemetry registry target, hub cert-manager prerequisite, and existing-cluster upgrade warning need correction.
3 open issues
What changed in this PR
Updates first-party documentation and deployment examples for operator 1.0.0, continuing the move to OCI-only Helm distribution.
Changes:
- Refreshes chart versions and removes outdated image overrides.
- Moves the contrib EKS installer to OCI and documents classic repository retirement.
- Explains independent operator/database versions and refreshes upgrade guidance.
| File | Description |
|---|---|
| test/e2e/README.md | Aligns documented upgrade defaults. |
| README.md | Notes classic Helm repository retirement. |
| operator/src/scripts/deployment-examples/create-cluster.sh | Pins chart 1.0.0. |
| operator/documentdb-helm-chart/UNIFIED-VERSION-CONTROL.md | Documents independent version tracks. |
| documentdb-playground/telemetry/scripts/create-cluster.sh | Updates chart version. |
| documentdb-playground/operator-upgrade-guide/README.md | Refreshes upgrade example versions. |
| documentdb-playground/operator-upgrade-guide/operator-upgrade.sh | Updates usage examples. |
| documentdb-playground/operator-upgrade-guide/operator-install.sh | Updates installation usage example. |
| documentdb-playground/lightrag/README.md | Clarifies engine compatibility. |
| documentdb-playground/lightrag/documentdb.yaml | Removes old image pins. |
| documentdb-playground/contrib/telemetry-and-cost-optimized-eks/scripts/create-cluster.sh | Installs chart 1.0.0 through OCI. |
| documentdb-playground/aws-setup/scripts/create-cluster.sh | Pins chart 1.0.0. |
| documentdb-playground/aks-setup/scripts/create-cluster.sh | Refreshes version-pinning comments. |
| documentdb-playground/aks-setup/README.md | Updates documented operator version. |
| docs/operator-public-documentation/preview/operations/upgrades.md | Adds OCI migration guidance and refreshes examples. |
| docs/operator-public-documentation/preview/operations/restore-deleted-cluster.md | Updates restore version example. |
| docs/operator-public-documentation/preview/operations/backup-and-restore.md | Updates backup restoration example. |
| docs/operator-public-documentation/preview/getting-started/before-you-start.md | Marks older releases superseded. |
| docs/developer-guides/testing-with-fork-images.md | Refreshes upstream image examples. |
| docs/developer-guides/sidecar-injector-plugin-configuration.md | Uses operator gateway image references. |
| docs/developer-guides/manual-multi-cloud-deployment-guide.md | Updates hub installation to chart 1.0.0. |
Review effort: Balanced
| # For production: use microsoft/documentdb-operator (official) | ||
| OPERATOR_GITHUB_ORG="hossain-rayhan" | ||
| OPERATOR_CHART_VERSION="0.1.112" | ||
| OPERATOR_CHART_VERSION="1.0.0" |
| ```bash | ||
| kubectl config use-context hub | ||
| helm install documentdb-operator oci://ghcr.io/documentdb/documentdb-operator --version 0.0.1-multi-arch --namespace documentdb-operator --create-namespace | ||
| helm install documentdb-operator oci://ghcr.io/documentdb/documentdb-operator --version 1.0.0 --namespace documentdb-operator --create-namespace |
| ``` | ||
|
|
||
| ## 🔧 **Version Management Workflow:** | ||
| To change the default for every new cluster: |
Member
Author
|
Closing in favour of #481. |
guanzhousongmicrosoft
force-pushed
the
developer/1.0-docs-followups
branch
from
October 19, 2026 13:23
125a431 to
1f6b9c8
Compare
guanzhousongmicrosoft
changed the title
guanzhousongmicrosoft
force-pushed
the
developer/1.0-docs-followups
branch
2 times, most recently
from
October 19, 2026 15:33
9933d3c to
37fc46b
Compare
Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
guanzhousongmicrosoft
force-pushed
the
developer/1.0-docs-followups
branch
from
October 19, 2026 15:39
37fc46b to
c3fe5ea
Compare
xgerman
approved these changes
Oct 19, 2026
udsmicrosoft
approved these changes
Oct 19, 2026
alaye-ms
approved these changes
Oct 19, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #481. These first-party scripts and docs still install pre-1.0 or nonexistent versions:
aws-setup,telemetry, contrib EKS anddeployment-examplesscripts pin chart0.1.0, which doesn't exist, or0.1.112from a personal fork.kubeVersion >= 1.33) refuses.documentDbVersion="16", which resolves to images that don't exist.0.110.0, the sidecar guide usesghcr.io/microsoft/documentdb/documentdb-local, and the multi-cloud guide uses0.0.1-multi-arch.