Update elasticsearch docs examples to latest supported version (xpack-9.2.3)#916
Update elasticsearch docs examples to latest supported version (xpack-9.2.3)#916tamalsaha wants to merge 5 commits into
Conversation
…-9.2.3) Bump the elasticsearch example/guide manifests to the latest supported version per installer active_versions.json. Deploy examples use the latest; version-upgrade guides keep an older source and upgrade to the latest. Illustrative command outputs and other products' versions are left unchanged. Signed-off-by: Tamal Saha <tamal@appscode.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (3)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughVersion strings across Elasticsearch and OpenSearch docs, examples, and guides were updated. Most changes replace older ChangesElasticsearch/OpenSearch version bump across docs and examples
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/guides/elasticsearch/backup/stash/kubedb/index.md (1)
874-874: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winUpdate stale narrative text to match the new OpenSearch version.
Line 874 states "we are using
1.9.0-opendistrovariant" but theinit-sampleYAML at Line 837 now usesopensearch-3.4.0. This narrative is inconsistent with the bumped version and will confuse readers.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/elasticsearch/backup/stash/kubedb/index.md` at line 874, Update the stale narrative in the docs section that describes the sample restore flow so it matches the current `init-sample` YAML version. The text near the backup/stash KubeDB example still references the old `1.9.0-opendistro` Elasticsearch variant, so revise that wording to reflect the `opensearch-3.4.0` image/version used in the sample while keeping the rest of the explanation about the `init` section and `waitForInitialRestore` intact.docs/guides/elasticsearch/plugins/x-pack/configuration.md (1)
84-84: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winUpdate outdated narrative version reference.
Line 84 states "we are going to use ElasticsearchVersion
7.3.2" but the YAML examples now usexpack-9.2.3. This narrative text is inconsistent with the updated manifests and should be revised to reference the correct version or removed if the version is no longer hardcoded in the explanation.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/elasticsearch/plugins/x-pack/configuration.md` at line 84, The narrative in the configuration guide is inconsistent with the updated YAML examples because it still references ElasticsearchVersion 7.3.2. Update the text near the ElasticsearchVersion mention to match the current xpack-9.2.3 manifests, or remove the hardcoded version reference if the explanation should stay version-agnostic. Keep the surrounding wording in sync with the examples in the guide so the `ElasticsearchVersion` and `xpack` configuration references remain consistent.docs/guides/elasticsearch/private-registry/using-private-registry.md (1)
85-138: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick winInconsistent ElasticsearchVersion CRD name and spec.version reference.
The ElasticsearchVersion CRD example at Line 89 defines
metadata.name: xpack-8.19.9, but the Elasticsearch CR at Line 138 referencesspec.version: "xpack-9.2.3". Since the guide explicitly states that the Elasticsearch object must "point this ElasticsearchVersion crd inspec.versionfield," the mismatch breaks the example contract. Update the ElasticsearchVersion CRD name toxpack-9.2.3(and itsspec.versionfield at Line 111) to match, or adjust the narrative if the older CRD is intentional.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/elasticsearch/private-registry/using-private-registry.md` around lines 85 - 138, The ElasticsearchVersion example and the Elasticsearch resource reference are inconsistent, so update the CRD definition in the ElasticsearchVersion example to use the same identifier as the Elasticsearch spec.version value. Make the name/version fields in the ElasticsearchVersion manifest match the Elasticsearch manifest referenced later in the guide, and ensure the surrounding text in using-private-registry.md still describes pointing the Elasticsearch object to that exact ElasticsearchVersion name.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guides/elasticsearch/clustering/combined-cluster/index.md`:
- Line 158: The documentation text uses the wrong distribution name in the
combined-cluster guide; update the wording in the relevant prose to say
OpenSearch instead of Opendistro. Locate the sentence mentioning the
Elasticsearch image and the `opensearch-3.4.0` image name, and replace the
distribution reference so it consistently matches the OpenSearch branding used
elsewhere in the guide.
- Line 40: Update the narrative in the combined-cluster guide so the image is
described as OpenSearch rather than Opendistro; adjust the wording around the
standalone Elasticsearch cluster setup to match the `opensearch-3.4.0` image and
keep the terminology consistent in the surrounding text. Use the relevant guide
content in the combined-cluster documentation to locate the sentence and replace
the distribution name with the correct OpenSearch reference.
In `@docs/guides/elasticsearch/quickstart/overview/opensearch/index.md`:
- Around line 129-131: The recommendation note in the OpenSearch quickstart
overview still uses a stale version example, which conflicts with the current
tutorial version. Update the note in the opensearch overview content so it
references the current `opensearch-3.4.0` example or rewrite it generically,
keeping the guidance aligned with the version used in the tutorial and avoiding
the old `opensearch-2.19.2` reference.
---
Outside diff comments:
In `@docs/guides/elasticsearch/backup/stash/kubedb/index.md`:
- Line 874: Update the stale narrative in the docs section that describes the
sample restore flow so it matches the current `init-sample` YAML version. The
text near the backup/stash KubeDB example still references the old
`1.9.0-opendistro` Elasticsearch variant, so revise that wording to reflect the
`opensearch-3.4.0` image/version used in the sample while keeping the rest of
the explanation about the `init` section and `waitForInitialRestore` intact.
In `@docs/guides/elasticsearch/plugins/x-pack/configuration.md`:
- Line 84: The narrative in the configuration guide is inconsistent with the
updated YAML examples because it still references ElasticsearchVersion 7.3.2.
Update the text near the ElasticsearchVersion mention to match the current
xpack-9.2.3 manifests, or remove the hardcoded version reference if the
explanation should stay version-agnostic. Keep the surrounding wording in sync
with the examples in the guide so the `ElasticsearchVersion` and `xpack`
configuration references remain consistent.
In `@docs/guides/elasticsearch/private-registry/using-private-registry.md`:
- Around line 85-138: The ElasticsearchVersion example and the Elasticsearch
resource reference are inconsistent, so update the CRD definition in the
ElasticsearchVersion example to use the same identifier as the Elasticsearch
spec.version value. Make the name/version fields in the ElasticsearchVersion
manifest match the Elasticsearch manifest referenced later in the guide, and
ensure the surrounding text in using-private-registry.md still describes
pointing the Elasticsearch object to that exact ElasticsearchVersion name.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: be6ec390-f19e-4c1a-ab4e-5d23e72702a8
📒 Files selected for processing (94)
docs/examples/elasticsearch/cli/elasticsearch-demo.yamldocs/examples/elasticsearch/clustering/multi-node-es.yamldocs/examples/elasticsearch/clustering/topology-es.yamldocs/examples/elasticsearch/custom-config/es-custom-with-topology.yamldocs/examples/elasticsearch/custom-config/es-custom.yamldocs/examples/elasticsearch/custom-rbac/es-custom-db-two.yamldocs/examples/elasticsearch/custom-rbac/es-custom-db.yamldocs/examples/elasticsearch/es-overview.yamldocs/examples/elasticsearch/initialization/recovered-es.yamldocs/examples/elasticsearch/kibana/es-kibana-demo.yamldocs/examples/elasticsearch/monitoring/builtin-prom-es.yamldocs/examples/elasticsearch/monitoring/coreos-prom-es.yamldocs/examples/elasticsearch/private-registry/private-registry.yamldocs/examples/elasticsearch/quickstart/instant-elasticsearch.yamldocs/examples/elasticsearch/quickstart/quick-elasticsearch.yamldocs/examples/elasticsearch/reconfigure-tls/Elasticsearch.yamldocs/examples/elasticsearch/scalling/horizontal/topology.yamldocs/examples/elasticsearch/update-version/elasticsearch.yamldocs/examples/elasticsearch/update-version/update-version.yamldocs/examples/elasticsearch/x-pack/config-elasticsearch.yamldocs/examples/elasticsearch/x-pack/custom-certificate-es-ssl.yamldocs/examples/elasticsearch/x-pack/es-mon-demo.yamldocs/examples/elasticsearch/x-pack/es-xpack-disabled.yamldocs/examples/elasticsearch/x-pack/ssl-elasticsearch.yamldocs/guides/elasticsearch/autoscaler/compute/combined/index.mddocs/guides/elasticsearch/autoscaler/compute/combined/yamls/es-combined.yamldocs/guides/elasticsearch/autoscaler/compute/topology/index.mddocs/guides/elasticsearch/autoscaler/compute/topology/yamls/es-topology.yamldocs/guides/elasticsearch/autoscaler/storage/combined/index.mddocs/guides/elasticsearch/autoscaler/storage/combined/yamls/es-combined.yamldocs/guides/elasticsearch/autoscaler/storage/topology/index.mddocs/guides/elasticsearch/autoscaler/storage/topology/yamls/es-topology.yamldocs/guides/elasticsearch/backup/kubestash/auto-backup/examples/sample-es-2.yamldocs/guides/elasticsearch/backup/kubestash/auto-backup/examples/sample-es.yamldocs/guides/elasticsearch/backup/kubestash/auto-backup/index.mddocs/guides/elasticsearch/backup/kubestash/customization/common/sample-es.yamldocs/guides/elasticsearch/backup/kubestash/logical/examples/restore-es.yamldocs/guides/elasticsearch/backup/kubestash/logical/examples/sample-es.yamldocs/guides/elasticsearch/backup/kubestash/logical/index.mddocs/guides/elasticsearch/backup/stash/auto-backup/examples/es-demo-2.yamldocs/guides/elasticsearch/backup/stash/auto-backup/examples/es-demo-3.yamldocs/guides/elasticsearch/backup/stash/auto-backup/examples/es-demo.yamldocs/guides/elasticsearch/backup/stash/auto-backup/index.mddocs/guides/elasticsearch/backup/stash/customization/examples/elasticsearch.yamldocs/guides/elasticsearch/backup/stash/kubedb/examples/elasticsearch/init_sample.yamldocs/guides/elasticsearch/backup/stash/kubedb/examples/elasticsearch/sample_es.yamldocs/guides/elasticsearch/backup/stash/kubedb/index.mddocs/guides/elasticsearch/cli/cli.mddocs/guides/elasticsearch/clustering/combined-cluster/index.mddocs/guides/elasticsearch/clustering/combined-cluster/yamls/es-multinode.yamldocs/guides/elasticsearch/clustering/combined-cluster/yamls/es-standalone.yamldocs/guides/elasticsearch/clustering/topology-cluster/hot-warm-cold-cluster/index.mddocs/guides/elasticsearch/clustering/topology-cluster/hot-warm-cold-cluster/yamls/es-cluster.yamldocs/guides/elasticsearch/clustering/topology-cluster/simple-dedicated-cluster/index.mddocs/guides/elasticsearch/clustering/topology-cluster/simple-dedicated-cluster/yamls/es-cluster.yamldocs/guides/elasticsearch/concepts/elasticsearch/index.mddocs/guides/elasticsearch/configuration/combined-cluster/index.mddocs/guides/elasticsearch/configuration/combined-cluster/yamls/es-combined.yamldocs/guides/elasticsearch/configuration/jvm-options/index.mddocs/guides/elasticsearch/configuration/jvm-options/yamls/elasticsearch.yamldocs/guides/elasticsearch/configuration/overview/index.mddocs/guides/elasticsearch/configuration/topology-cluster/index.mddocs/guides/elasticsearch/configuration/topology-cluster/yamls/es-topology.yamldocs/guides/elasticsearch/custom-rbac/using-custom-rbac.mddocs/guides/elasticsearch/elasticsearch-dashboard/kibana/index.mddocs/guides/elasticsearch/elasticsearch-dashboard/kibana/yamls/es-cluster.yamldocs/guides/elasticsearch/elasticsearch-dashboard/opensearch-dashboards/index.mddocs/guides/elasticsearch/elasticsearch-dashboard/opensearch-dashboards/yamls/os-cluster.yamldocs/guides/elasticsearch/gitops/gitops.mddocs/guides/elasticsearch/monitoring/using-builtin-prometheus.mddocs/guides/elasticsearch/monitoring/using-prometheus-operator.mddocs/guides/elasticsearch/plugins-backup/s3-repository/index.mddocs/guides/elasticsearch/plugins-backup/s3-repository/yamls/elasticsearch.yamldocs/guides/elasticsearch/plugins/x-pack/configuration.mddocs/guides/elasticsearch/plugins/x-pack/disable-xpack.mddocs/guides/elasticsearch/plugins/x-pack/issue-certificate.mddocs/guides/elasticsearch/plugins/x-pack/use-tls.mddocs/guides/elasticsearch/private-registry/using-private-registry.mddocs/guides/elasticsearch/quickstart/overview/elasticsearch/index.mddocs/guides/elasticsearch/quickstart/overview/elasticsearch/yamls/elasticsearch-v1.yamldocs/guides/elasticsearch/quickstart/overview/elasticsearch/yamls/elasticsearch-v1alpha2.yamldocs/guides/elasticsearch/quickstart/overview/opensearch/index.mddocs/guides/elasticsearch/quickstart/overview/opensearch/yamls/opensearch-v1.yamldocs/guides/elasticsearch/quickstart/overview/opensearch/yamls/opensearch-v1alpha2.yamldocs/guides/elasticsearch/reconfigure_tls/elasticsearch.mddocs/guides/elasticsearch/restart/index.mddocs/guides/elasticsearch/rotateauth/rotateauth.mddocs/guides/elasticsearch/scaling/horizontal/combined.mddocs/guides/elasticsearch/scaling/horizontal/topology.mddocs/guides/elasticsearch/scaling/vertical/combined.mddocs/guides/elasticsearch/scaling/vertical/topology.mddocs/guides/elasticsearch/update-version/elasticsearch.mddocs/guides/elasticsearch/volume-expansion/combined.mddocs/guides/elasticsearch/volume-expansion/topology.md
Signed-off-by: Fazle Rabbi Sarker <fazlerabbi@appscode.com>
8fad2f3
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/guides/elasticsearch/plugins/x-pack/configuration.md (1)
47-73: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winKeep the X-Pack version consistent throughout this walkthrough.
The authPlugin example still uses
xpack-8.19.9, while the deploy example below has moved toxpack-9.2.3. That leaves readers with two different versions in one flow; either update the earlier example to9.2.3as well, or make the section explicitly generic.Also applies to: 84-95
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/elasticsearch/plugins/x-pack/configuration.md` around lines 47 - 73, The X-Pack walkthrough mixes ElasticsearchVersion examples from two different releases, which makes the flow inconsistent. Update the earlier ElasticsearchVersion example identified by xpack-8.19.9 to match the later xpack-9.2.3 deploy example, or rewrite the section in a version-neutral way so the authPlugin, image, initContainer, backup/restore task names, and version fields all stay consistent throughout the walkthrough.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/guides/elasticsearch/plugins/x-pack/configuration.md`:
- Around line 47-73: The X-Pack walkthrough mixes ElasticsearchVersion examples
from two different releases, which makes the flow inconsistent. Update the
earlier ElasticsearchVersion example identified by xpack-8.19.9 to match the
later xpack-9.2.3 deploy example, or rewrite the section in a version-neutral
way so the authPlugin, image, initContainer, backup/restore task names, and
version fields all stay consistent throughout the walkthrough.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 208089dd-9194-4af1-869d-1999358b102f
📒 Files selected for processing (41)
docs/examples/elasticsearch/private-registry/pvt-elasticsearchversion.yamldocs/examples/elasticsearch/x-pack/esversion-none.yamldocs/guides/elasticsearch/autoscaler/compute/combined/index.mddocs/guides/elasticsearch/autoscaler/compute/topology/index.mddocs/guides/elasticsearch/autoscaler/storage/combined/index.mddocs/guides/elasticsearch/autoscaler/storage/topology/index.mddocs/guides/elasticsearch/backup/kubestash/auto-backup/index.mddocs/guides/elasticsearch/backup/kubestash/logical/index.mddocs/guides/elasticsearch/backup/stash/kubedb/index.mddocs/guides/elasticsearch/clustering/combined-cluster/index.mddocs/guides/elasticsearch/clustering/topology-cluster/hot-warm-cold-cluster/index.mddocs/guides/elasticsearch/clustering/topology-cluster/simple-dedicated-cluster/index.mddocs/guides/elasticsearch/concepts/catalog/index.mddocs/guides/elasticsearch/configuration/combined-cluster/index.mddocs/guides/elasticsearch/configuration/jvm-options/index.mddocs/guides/elasticsearch/configuration/topology-cluster/index.mddocs/guides/elasticsearch/custom-rbac/using-custom-rbac.mddocs/guides/elasticsearch/elasticsearch-dashboard/kibana/index.mddocs/guides/elasticsearch/elasticsearch-dashboard/opensearch-dashboards/index.mddocs/guides/elasticsearch/gitops/gitops.mddocs/guides/elasticsearch/plugins-backup/s3-repository/index.mddocs/guides/elasticsearch/plugins/search-guard/configuration.mddocs/guides/elasticsearch/plugins/search-guard/disable-searchguard.mddocs/guides/elasticsearch/plugins/search-guard/issue-certificate.mddocs/guides/elasticsearch/plugins/search-guard/x-pack-monitoring.mddocs/guides/elasticsearch/plugins/x-pack/configuration.mddocs/guides/elasticsearch/plugins/x-pack/disable-xpack.mddocs/guides/elasticsearch/plugins/x-pack/issue-certificate.mddocs/guides/elasticsearch/plugins/x-pack/use-tls.mddocs/guides/elasticsearch/private-registry/using-private-registry.mddocs/guides/elasticsearch/quickstart/overview/elasticsearch/index.mddocs/guides/elasticsearch/quickstart/overview/opensearch/index.mddocs/guides/elasticsearch/reconfigure_tls/elasticsearch.mddocs/guides/elasticsearch/rotateauth/rotateauth.mddocs/guides/elasticsearch/scaling/horizontal/combined.mddocs/guides/elasticsearch/scaling/horizontal/topology.mddocs/guides/elasticsearch/scaling/vertical/combined.mddocs/guides/elasticsearch/scaling/vertical/topology.mddocs/guides/elasticsearch/update-version/elasticsearch.mddocs/guides/elasticsearch/volume-expansion/combined.mddocs/guides/elasticsearch/volume-expansion/topology.md
✅ Files skipped from review due to trivial changes (33)
- docs/examples/elasticsearch/private-registry/pvt-elasticsearchversion.yaml
- docs/guides/elasticsearch/plugins/search-guard/x-pack-monitoring.md
- docs/guides/elasticsearch/plugins/search-guard/disable-searchguard.md
- docs/guides/elasticsearch/plugins/search-guard/issue-certificate.md
- docs/guides/elasticsearch/autoscaler/storage/combined/index.md
- docs/guides/elasticsearch/autoscaler/storage/topology/index.md
- docs/guides/elasticsearch/reconfigure_tls/elasticsearch.md
- docs/guides/elasticsearch/rotateauth/rotateauth.md
- docs/guides/elasticsearch/scaling/horizontal/combined.md
- docs/guides/elasticsearch/configuration/combined-cluster/index.md
- docs/guides/elasticsearch/plugins/search-guard/configuration.md
- docs/guides/elasticsearch/scaling/vertical/combined.md
- docs/guides/elasticsearch/volume-expansion/combined.md
- docs/guides/elasticsearch/autoscaler/compute/topology/index.md
- docs/guides/elasticsearch/clustering/topology-cluster/simple-dedicated-cluster/index.md
- docs/guides/elasticsearch/concepts/catalog/index.md
- docs/guides/elasticsearch/autoscaler/compute/combined/index.md
- docs/guides/elasticsearch/plugins-backup/s3-repository/index.md
- docs/guides/elasticsearch/scaling/horizontal/topology.md
- docs/guides/elasticsearch/private-registry/using-private-registry.md
- docs/guides/elasticsearch/clustering/combined-cluster/index.md
- docs/guides/elasticsearch/update-version/elasticsearch.md
- docs/guides/elasticsearch/custom-rbac/using-custom-rbac.md
- docs/guides/elasticsearch/volume-expansion/topology.md
- docs/guides/elasticsearch/scaling/vertical/topology.md
- docs/guides/elasticsearch/elasticsearch-dashboard/opensearch-dashboards/index.md
- docs/guides/elasticsearch/plugins/x-pack/issue-certificate.md
- docs/guides/elasticsearch/plugins/x-pack/use-tls.md
- docs/guides/elasticsearch/backup/stash/kubedb/index.md
- docs/guides/elasticsearch/backup/kubestash/logical/index.md
- docs/guides/elasticsearch/elasticsearch-dashboard/kibana/index.md
- docs/guides/elasticsearch/configuration/jvm-options/index.md
- docs/guides/elasticsearch/gitops/gitops.md
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/guides/elasticsearch/configuration/topology-cluster/index.md
- docs/guides/elasticsearch/clustering/topology-cluster/hot-warm-cold-cluster/index.md
- docs/guides/elasticsearch/backup/kubestash/auto-backup/index.md
Signed-off-by: Fazle Rabbi Sarker <fazlerabbi@appscode.com>
|
Visit the preview URL for this PR (updated for commit e6283ba): https://kubedb-v2-hugo--pr916-update-elasticsearch-hvmsnnq3.web.app (expires Thu, 09 Jul 2026 05:50:03 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
Bumps the elasticsearch example and guide manifests to the latest supported version (
xpack-9.2.3) per the installeractive_versions.json.kubectl get ...versiontables,describedumps) and other products'/backend versions are left unchanged.Summary by CodeRabbit
xpack-9.2.3andopensearch-3.4.0) across example manifests and narrative text.kubectl get/describeand related checks) so the displayed versions stay consistent with the updated manifests.