feat: added opensearch guide

[chideat]

Summary by CodeRabbit

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

[coderabbitai]

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 title 'feat: added opensearch guide' accurately reflects 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

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

• ✨ 136.113.208.247/32 (new)
• 34.170.211.100/32
• 35.222.179.152/32

Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

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.

[Copilot]

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.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/en/solutions/ecosystem/opensearch/OpenSearch_Installation_Guide.md`:
- Around line 14-21: Update the "Supported Versions" section to add a
compatibility caution: annotate the Supported Versions table row(s) for
OpenSearch 3.3.1 and OpenSearch Operator 2.8.0 with a note that OpenSearch 3.3.1
falls within the Operator 2.8.0 supported range but may not have explicit
compatibility testing; instruct readers to validate in non-production
environments before deploying and mention that Alauda ACP does not officially
manage OpenSearch so compatibility is based on the Operator's tested matrix
rather than Alauda platform guarantees.