From c3fe5ea9286894b1538f88c99eb810818a279245 Mon Sep 17 00:00:00 2001 From: Guanzhou Song Date: Mon, 19 Oct 2026 11:32:44 -0400 Subject: [PATCH] docs: point scripts and docs at operator 1.0.0 Signed-off-by: Guanzhou Song --- .../manual-multi-cloud-deployment-guide.md | 2 +- .../sidecar-injector-plugin-configuration.md | 10 +++++----- .../preview/getting-started/deploy-on-eks.md | 6 +++--- .../preview/operations/backup-and-restore.md | 2 +- .../operations/restore-deleted-cluster.md | 2 +- .../aws-setup/scripts/create-cluster.sh | 2 +- .../scripts/create-cluster.sh | 17 +++++++---------- documentdb-playground/lightrag/documentdb.yaml | 6 +----- .../telemetry/scripts/create-cluster.sh | 4 ++-- .../tls/MANUAL-PROVIDED-MODE-SETUP.md | 5 +---- .../deployment-examples/create-cluster.sh | 2 +- 11 files changed, 24 insertions(+), 34 deletions(-) diff --git a/docs/developer-guides/manual-multi-cloud-deployment-guide.md b/docs/developer-guides/manual-multi-cloud-deployment-guide.md index 50c44f363..988d356ab 100644 --- a/docs/developer-guides/manual-multi-cloud-deployment-guide.md +++ b/docs/developer-guides/manual-multi-cloud-deployment-guide.md @@ -128,7 +128,7 @@ cert-manager cert-manager-webhook-7cc5dccc4b-7jmrh 1/1 Runn ```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 ``` Verify the namespaces cnpg-system and documentdb-operator were created diff --git a/docs/developer-guides/sidecar-injector-plugin-configuration.md b/docs/developer-guides/sidecar-injector-plugin-configuration.md index 2dc7b8deb..c178461a4 100644 --- a/docs/developer-guides/sidecar-injector-plugin-configuration.md +++ b/docs/developer-guides/sidecar-injector-plugin-configuration.md @@ -43,7 +43,7 @@ spec: pvcSize: "10Gi" # Explicitly specify gateway image image: - gateway: "ghcr.io/microsoft/documentdb/documentdb-local:17" + gateway: "ghcr.io/documentdb/documentdb-kubernetes-operator/gateway:1.0.0" exposeViaService: serviceType: "ClusterIP" ``` @@ -51,7 +51,7 @@ spec: **Built-in Fallback:** If no explicit spec configuration is set, the system falls back to: ``` -ghcr.io/microsoft/documentdb/documentdb-local:16 +ghcr.io/documentdb/documentdb-kubernetes-operator/gateway:1.0.0 ``` ### 2. Pod Labels Configuration @@ -92,7 +92,7 @@ spec: plugins: - name: cnpg-i-sidecar-injector.documentdb.io parameters: - gatewayImage: "ghcr.io/microsoft/documentdb/documentdb-local:17" + gatewayImage: "ghcr.io/documentdb/documentdb-kubernetes-operator/gateway:1.0.0" labels: '{"environment":"production","team":"data"}' annotations: '{"prometheus.io/scrape":"true"}' ``` @@ -113,7 +113,7 @@ spec: storage: pvcSize: "10Gi" image: - gateway: "ghcr.io/microsoft/documentdb/documentdb-local:17" + gateway: "ghcr.io/documentdb/documentdb-kubernetes-operator/gateway:1.0.0" ``` ### Advanced Configuration (All Parameters) @@ -130,7 +130,7 @@ spec: storage: pvcSize: "20Gi" image: - gateway: "ghcr.io/microsoft/documentdb/documentdb-local:17" + gateway: "ghcr.io/documentdb/documentdb-kubernetes-operator/gateway:1.0.0" plugins: sidecarInjectorName: "cnpg-i-sidecar-injector.documentdb.io" exposeViaService: diff --git a/docs/operator-public-documentation/preview/getting-started/deploy-on-eks.md b/docs/operator-public-documentation/preview/getting-started/deploy-on-eks.md index 6ee549660..90d342363 100644 --- a/docs/operator-public-documentation/preview/getting-started/deploy-on-eks.md +++ b/docs/operator-public-documentation/preview/getting-started/deploy-on-eks.md @@ -58,7 +58,7 @@ flowchart TB |------|---------|---------|--------------| | AWS CLI | 2.x | AWS authentication and resource management | [Install AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) | | eksctl | 0.160+ | EKS cluster creation and management | [Install eksctl](https://eksctl.io/installation/) | -| kubectl | 1.32+ | Kubernetes cluster interaction (must match EKS version) | [Install kubectl](https://kubernetes.io/docs/tasks/tools/) | +| kubectl | 1.35+ | Kubernetes cluster interaction (must match EKS version) | [Install kubectl](https://kubernetes.io/docs/tasks/tools/) | | Helm | 3.x | Package management for Kubernetes | [Install Helm](https://helm.sh/docs/intro/install/) | | jq | 1.6+ | JSON processing (optional) | `apt install jq` or `brew install jq` | @@ -166,7 +166,7 @@ export REGION="us-west-2" eksctl create cluster \ --name $CLUSTER_NAME \ --region $REGION \ - --version 1.32 \ + --version 1.35 \ --node-type m5.large \ --nodes 2 \ --nodes-min 1 \ @@ -594,7 +594,7 @@ For development/testing, use smaller instances: eksctl create cluster \ --name $CLUSTER_NAME \ --region $REGION \ - --version 1.32 \ + --version 1.35 \ --node-type t3.medium \ --nodes 2 ``` diff --git a/docs/operator-public-documentation/preview/operations/backup-and-restore.md b/docs/operator-public-documentation/preview/operations/backup-and-restore.md index 7bf86874a..0db80f79f 100644 --- a/docs/operator-public-documentation/preview/operations/backup-and-restore.md +++ b/docs/operator-public-documentation/preview/operations/backup-and-restore.md @@ -204,7 +204,7 @@ spec: nodeCount: 1 instancesPerNode: 1 # Set to the backup's schema version or newer (see Version compatibility). - documentDBVersion: "0.110.0" + documentDBVersion: "1.0.0" resource: storage: pvcSize: 10Gi diff --git a/docs/operator-public-documentation/preview/operations/restore-deleted-cluster.md b/docs/operator-public-documentation/preview/operations/restore-deleted-cluster.md index 0c300aa34..201984953 100644 --- a/docs/operator-public-documentation/preview/operations/restore-deleted-cluster.md +++ b/docs/operator-public-documentation/preview/operations/restore-deleted-cluster.md @@ -67,7 +67,7 @@ spec: nodeCount: 1 instancesPerNode: 1 # Set to the PV data's schema version or newer (see Version compatibility). - documentDBVersion: "0.110.0" + documentDBVersion: "1.0.0" documentDbCredentialSecret: documentdb-credentials resource: storage: diff --git a/documentdb-playground/aws-setup/scripts/create-cluster.sh b/documentdb-playground/aws-setup/scripts/create-cluster.sh index 08c875bf0..17094d620 100755 --- a/documentdb-playground/aws-setup/scripts/create-cluster.sh +++ b/documentdb-playground/aws-setup/scripts/create-cluster.sh @@ -23,7 +23,7 @@ CLUSTER_TAGS="${CLUSTER_TAGS:-project=documentdb-playground,environment=dev,mana # DocumentDB Operator Configuration # For production: use documentdb/documentdb-operator (official) OPERATOR_GITHUB_ORG="documentdb" -OPERATOR_CHART_VERSION="0.1.0" +OPERATOR_CHART_VERSION="1.0.0" # Feature flags - set to "true" to enable, "false" to skip INSTALL_OPERATOR="${INSTALL_OPERATOR:-false}" diff --git a/documentdb-playground/contrib/telemetry-and-cost-optimized-eks/scripts/create-cluster.sh b/documentdb-playground/contrib/telemetry-and-cost-optimized-eks/scripts/create-cluster.sh index c82eb4f15..e3e29dcc6 100755 --- a/documentdb-playground/contrib/telemetry-and-cost-optimized-eks/scripts/create-cluster.sh +++ b/documentdb-playground/contrib/telemetry-and-cost-optimized-eks/scripts/create-cluster.sh @@ -23,7 +23,7 @@ CLUSTER_TAGS="${CLUSTER_TAGS:-project=documentdb-playground,environment=dev,mana # DocumentDB Operator Configuration # For production: use documentdb/documentdb-operator (official) OPERATOR_GITHUB_ORG="documentdb" -OPERATOR_CHART_VERSION="0.1.0" +OPERATOR_CHART_VERSION="1.0.0" # Feature flags - set to "true" to enable, "false" to skip INSTALL_OPERATOR="${INSTALL_OPERATOR:-false}" @@ -678,21 +678,18 @@ install_documentdb_operator() { return 0 fi - # Try public Helm repository first (no authentication required) - log "Adding DocumentDB public Helm repository..." - helm repo add documentdb https://documentdb.github.io/documentdb-kubernetes-operator 2>/dev/null || true - helm repo update documentdb - - log "Installing DocumentDB operator from public Helm repository..." - if helm install documentdb-operator documentdb/documentdb-operator \ + # Try an anonymous OCI install first (the chart is public) + log "Installing DocumentDB operator from oci://ghcr.io/${OPERATOR_GITHUB_ORG}/documentdb-operator..." + if helm install documentdb-operator oci://ghcr.io/${OPERATOR_GITHUB_ORG}/documentdb-operator \ + --version ${OPERATOR_CHART_VERSION} \ --namespace documentdb-operator \ --create-namespace \ --wait \ --timeout 10m 2>/dev/null; then - success "DocumentDB operator installed successfully from public Helm repository" + success "DocumentDB operator installed successfully from OCI registry" else # Fallback to OCI registry with GitHub authentication - warn "Public Helm repository installation failed. Falling back to OCI registry..." + warn "Anonymous OCI installation failed. Retrying with GitHub authentication..." # Check for GitHub authentication if [ -z "$GITHUB_TOKEN" ] || [ -z "$GITHUB_USERNAME" ]; then diff --git a/documentdb-playground/lightrag/documentdb.yaml b/documentdb-playground/lightrag/documentdb.yaml index aa97052b2..2be9a7ce9 100644 --- a/documentdb-playground/lightrag/documentdb.yaml +++ b/documentdb-playground/lightrag/documentdb.yaml @@ -7,8 +7,7 @@ # Notes: # - LightRAG requires DocumentDB extension v0.110.0 or later for the `_id` # lookup fix (https://github.com/documentdb/documentdb/pull/459). -# v0.110.0+ is the default in recent operator releases; pinning the images -# here makes the requirement explicit. +# The operator's default engine (1.0.0) includes it. # - Replace the password before using outside a throwaway dev cluster. --- apiVersion: v1 @@ -29,9 +28,6 @@ metadata: spec: nodeCount: 1 instancesPerNode: 1 - image: - documentDB: ghcr.io/documentdb/documentdb-kubernetes-operator/documentdb:0.110.0 - gateway: ghcr.io/documentdb/documentdb-kubernetes-operator/gateway:0.110.0 documentDbCredentialSecret: docdb-credentials resource: storage: diff --git a/documentdb-playground/telemetry/scripts/create-cluster.sh b/documentdb-playground/telemetry/scripts/create-cluster.sh index e6696ec45..e0a6d086a 100755 --- a/documentdb-playground/telemetry/scripts/create-cluster.sh +++ b/documentdb-playground/telemetry/scripts/create-cluster.sh @@ -16,8 +16,8 @@ KUBERNETES_VERSION="1.35.0" # DocumentDB Operator Configuration # For testing: use hossain-rayhan/documentdb-operator (fork with Azure enhancements) # For production: use microsoft/documentdb-operator (official) -OPERATOR_GITHUB_ORG="hossain-rayhan" -OPERATOR_CHART_VERSION="0.1.112" +OPERATOR_GITHUB_ORG="documentdb" +OPERATOR_CHART_VERSION="1.0.0" # Feature flags - set to "true" to enable, "false" to skip INSTALL_OPERATOR="${INSTALL_OPERATOR:-false}" diff --git a/documentdb-playground/tls/MANUAL-PROVIDED-MODE-SETUP.md b/documentdb-playground/tls/MANUAL-PROVIDED-MODE-SETUP.md index d7e14818e..8d1e93549 100644 --- a/documentdb-playground/tls/MANUAL-PROVIDED-MODE-SETUP.md +++ b/documentdb-playground/tls/MANUAL-PROVIDED-MODE-SETUP.md @@ -234,15 +234,12 @@ kubectl create namespace documentdb-operator --dry-run=client -o yaml | kubectl # Install operator (adjust image references as needed) cd /path/to/operator/documentdb-helm-chart helm upgrade --install documentdb-operator . \ - -n documentdb-operator \ - --set documentDbVersion="16" + -n documentdb-operator # Verify installation kubectl -n documentdb-operator get pods ``` -**Why override `documentDbVersion`?** The Helm chart defaults to `0.1.0`, and the operator uses that value when selecting the gateway image. Without this override, the CNPG pod attempts to pull `ghcr.io/documentdb/documentdb/documentdb-local:0.1.0`, which doesn't exist. - ## Step 1: Deploy DocumentDB with LoadBalancer ### 1.1 Create Namespace and Credentials diff --git a/operator/src/scripts/deployment-examples/create-cluster.sh b/operator/src/scripts/deployment-examples/create-cluster.sh index 66453c134..1442bcd2c 100755 --- a/operator/src/scripts/deployment-examples/create-cluster.sh +++ b/operator/src/scripts/deployment-examples/create-cluster.sh @@ -17,7 +17,7 @@ KUBERNETES_VERSION="1.35.0" # For testing: use hossain-rayhan/documentdb-operator (fork with Azure enhancements) # For production: use microsoft/documentdb-operator (official) OPERATOR_GITHUB_ORG="documentdb" -OPERATOR_CHART_VERSION="0.1.0" +OPERATOR_CHART_VERSION="1.0.0" # Feature flags - set to "true" to enable, "false" to skip INSTALL_OPERATOR="${INSTALL_OPERATOR:-false}" DEPLOY_INSTANCE="${DEPLOY_INSTANCE:-false}"