Advanced search - OpenSearch configuration #185
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAdds OpenSearch-based advanced search docs and environment variables, and reorders navigation to place Changes
Sequence Diagram(s)sequenceDiagram
participant User as "User"
participant API as "Plane API Pod"
participant Redis as "Redis"
participant Cel as "Celery Workers"
participant OS as "OpenSearch"
User->>API: Trigger indexing or search request
API->>Redis: Enqueue indexing task
Redis--)Cel: Task queued (pub/sub)
Cel->>API: Fetch task details
Cel->>OS: Index documents (bulk/index API)
OS-->>Cel: Acknowledge
Cel-->>API: Task completion status
API-->>User: Confirm indexing / return search results
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
danciaclara
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In `@self-hosting/govern/advanced-search.mdx`:
- Around line 42-48: The OPENSEARCH_INDEX_PREFIX example uses a trailing
underscore ("plane_") which combined with templates that append "_issues" will
produce a double underscore; update all examples (the OPENSEARCH_INDEX_PREFIX
values shown and any Helm/chart defaults) to use a prefix without a trailing
underscore (e.g., "plane") or adjust the index-template to concatenate safely
(avoid "{prefix}_issues" when prefix already ends with "_"); specifically change
occurrences of OPENSEARCH_INDEX_PREFIX that show "plane_" to "plane" (also apply
the same fix at the other mentioned locations).
- Around line 121-131: Replace the misspelled word "commmands" with "commands"
in the two occurrences inside the advanced-search content (the lines that read
"Run these commmands in the API pod." before the bash block that starts with "#
Get the API pod name" and the later "Run these commmands in the API pod." under
"4. **Index your existing data**"); update both instances so the phrase reads
"Run these commands in the API pod." to correct the typo.
- Around line 155-165: Replace the insecure example that sets verify_certs=False
with guidance and a snippet that uses verify_certs=True and a CA bundle
(referencing OpenSearch constructor, verify_certs, ca_certs and
settings.OPENSEARCH_DSL['default'] values); keep a short note that
verify_certs=False is only a temporary, non-production workaround for
self-signed testing and should not be recommended, and show providing
ca_certs="/path/to/ca-bundle.pem" or relying on the system/certifi CA store as
the secure default.
In `@self-hosting/govern/environment-variables.mdx`:
- Around line 142-148: The OPENSEARCH_INDEX_PREFIX table row has the Description
and Default Value columns swapped; update the row for the
`OPENSEARCH_INDEX_PREFIX` entry so the Description column reads "Prefix for all
index names (useful for multi-tenant setups)" and the Default Value column reads
"(empty)"—ensure the table cell order matches the other rows and the header
(Variable | Description | Default Value).
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@self-hosting/govern/advanced-search.mdx`:
- Around line 277-279: Replace the unhyphenated phrase "full text search" with
"full‑text search" in the text block that currently reads "Work items benefit
from full text search."; ensure any other occurrences of the adjective phrase
"full text" in the document are similarly hyphenated to "full‑text" so the
compound modifier is correct.
♻️ Duplicate comments (1)
self-hosting/govern/advanced-search.mdx (1)
155-164: Avoidverify_certs=Falsein the default snippet.Line 162 disables TLS verification; that’s unsafe as a default. Prefer
verify_certs=Truewith a CA bundle (or system/Certifi CA store) and only mentionFalseas a temporary dev/test workaround.🔒️ Suggested secure snippet
client = OpenSearch( hosts=[settings.OPENSEARCH_DSL['default']['hosts']], http_auth=settings.OPENSEARCH_DSL['default']['http_auth'], use_ssl=True, - verify_certs=False + verify_certs=True, + ca_certs="/path/to/ca-bundle.pem" # or omit to use system/certifi CA store )OpenSearch Python client verify_certs ca_certs recommended production settings
🧹 Nitpick comments (1)
self-hosting/govern/environment-variables.mdx (1)
140-148: Match table formatting with the rest of the doc.Line 142–148 uses backticks for variable names and a plain “(empty)” default, while earlier sections use bold variable names and italicized empty defaults. Consider aligning for consistency.
♻️ Suggested tweak
-| `OPENSEARCH_ENABLED` | Enable OpenSearch integration | `1` | -| `OPENSEARCH_URL` | OpenSearch endpoint URL | `https://opensearch.example.com:9200/` | -| `OPENSEARCH_USERNAME` | Authentication username | `admin` | -| `OPENSEARCH_PASSWORD` | Authentication password | `your-secure-password` | -| `OPENSEARCH_INDEX_PREFIX` | Prefix for all index names (useful for multi-tenant setups) | (empty) | +| **OPENSEARCH_ENABLED** | Enable OpenSearch integration | `1` | +| **OPENSEARCH_URL** | OpenSearch endpoint URL | `https://opensearch.example.com:9200/` | +| **OPENSEARCH_USERNAME** | Authentication username | `admin` | +| **OPENSEARCH_PASSWORD** | Authentication password | `your-secure-password` | +| **OPENSEARCH_INDEX_PREFIX** | Prefix for all index names (useful for multi-tenant setups) | *(empty)* |
akshat5302
approved these changes
Jan 21, 2026
dheeru0198
approved these changes
Jan 21, 2026
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.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.