Skip to content

Conversation

@chideat
Copy link
Collaborator

@chideat chideat commented Jan 29, 2026

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive OpenSearch Installation Guide covering overview, supported versions, prerequisites, operator installation, Quick Start (3-node example), deployment verification, and Dashboards access.
    • Includes node-role descriptions, production best practices, capacity planning and benchmarking guidance, configuration reference with common options, guidance for PSA/restricted-namespace deployments (security contexts and fsGroup), and multiple YAML examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 29, 2026

Walkthrough

Adds a new OpenSearch Installation Guide documenting deploying the OpenSearch Kubernetes Operator on Alauda, a Quick Start 3-node cluster with YAML samples, verification and Dashboards access, node roles and production guidance, PSA/restricted-namespace security notes, configuration reference, and external links. (41 words)

Changes

Cohort / File(s) Summary
OpenSearch Installation Documentation
docs/en/solutions/ecosystem/opensearch/OpenSearch_Installation_Guide.md
New comprehensive guide covering operator installation on Alauda, supported versions, prerequisites, Quick Start 3-node cluster YAML and verification steps, OpenSearch Dashboards access, node roles and best practices, capacity/benchmarking notes, PSA/restricted-namespace security guidance (securityContext, fsGroup), additionalConfig reference, multiple YAML samples and external references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • shibalu
  • tyzhou111

Poem

🐰 I hopped through docs with careful cheer,

YAML carrots lined in rows so near,
Clusters wake and dashboards glow,
Nodes align in tidy row,
Hooray — search springs forth to steer!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'feat: added opensearch guide' directly describes the main change—adding a new OpenSearch installation guide documentation file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch opensearch_guide

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@docs/en/solutions/ecosystem/opensearch/OpenSearch_Installation_Guide.md`:
- Around line 16-20: The markdown tables in this file (for example the header
row "| Component | Supported Versions |" and its following rows) are missing
spaces around the pipe characters and failing markdownlint MD060; update every
table (including the ranges noted: lines ~134-143, 264-271, 393-401, 523-529,
671-684) so each pipe has a single space on both sides (e.g., "| Column | Column
|"), or run the repository’s markdown formatter to normalize table pipe spacing
across all affected tables.
- Around line 99-105: Replace the hard-coded basic auth credentials in the curl
examples (the kubectl exec ... curl -sk -u admin:admin
https://localhost:9200/_cluster/health?pretty and the similar snippet at lines
358-364) with a placeholder or environment-variable reference (e.g., use a
variable like $OPENSEARCH_USER and $OPENSEARCH_PASS or a single
$OPENSEARCH_CRED) so the docs do not contain secrets; update the example text to
show setting the env var before use and use that variable in the curl -u
argument to keep the example functional but safe for secret scanning.
- Around line 383-665: The file contains a duplicated section starting at the
second "## Understanding Node Roles" through the repeated "## Deploy in
Restricted Namespaces (Pod Security Standards)"/PSA content which causes MD024
and bloats the doc; remove the entire duplicate block (the repeated
"Understanding Node Roles" heading and everything up to the PSA/Volume
Permission Handling content) so only the original single set of node-roles and
PSA guidance remains, ensuring references like the "Understanding Node Roles"
heading, "When to Use Each Role" examples, and "Deploy in Restricted Namespaces
(Pod Security Standards)" / "Volume Permission Handling" sections appear only
once.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a comprehensive installation and operations guide for running OpenSearch via the OpenSearch Kubernetes Operator on Alauda Container Platform (ACP).

Changes:

  • Introduces a new OpenSearch_Installation_Guide.md covering operator installation, quick-start cluster creation, and access to OpenSearch Dashboards.
  • Documents node roles, sizing patterns (small/medium/large clusters), and configuration reference fields for the OpenSearch operator CR.
  • Adds guidance for deploying OpenSearch in restricted namespaces with Pod Security Admission, including security contexts and volume permission handling.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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