Skip to content

[DRAFT]: Segregate opensearch changes in Plane EE #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
akshat5302 wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

[DRAFT]: Segregate opensearch changes in Plane EE #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bff7dee
Add OpenSearch service configuration to Plane Enterprise Helm chart
akshat5302 Dec 1, 2025
9fb1782
Merge branch 'master' of https://github.com/makeplane/helm-charts int…
akshat5302 Dec 2, 2025
734c6c4
Add OpenSearch documentation to README.md
akshat5302 Dec 2, 2025
7cc66a6
Add remote OpenSearch URL, username, and password to external secrets…
akshat5302 Dec 2, 2025
7d69674
Fix external secrets documentation for remote OpenSearch
akshat5302 Dec 2, 2025
4025168
Merge duplicate OPENSEARCH_PASSWORD entries in external secrets docum…
akshat5302 Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions charts/plane-enterprise/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,28 @@
| services.rabbitmq.annotations | {} | | This key allows you to set custom annotations for the stateful deployment of `rabbitmq`. This is useful for adding metadata or configuration hints to your resources. |
| services.rabbitmq.external_rabbitmq_url | | | Users can also decide to use the remote hosted service and link to Plane deployment. Ignoring all the above keys, set `services.rabbitmq.local_setup` to `false` and set this key with remote connection url. |

### OpenSearch Setup

| Setting | Default | Required | Description |
| --------------------------------------- | :-------------------------------: | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| services.opensearch.local_setup | true | | Plane uses `opensearch` as the search and analytics engine. This can be hosted within kubernetes as part of helm chart deployment or can be used as hosted service remotely (e.g. AWS OpenSearch Service or similar services). Set this to `true` when you choose to setup stateful deployment of `opensearch`. Mark it as `false` when using a remotely hosted service |
| services.opensearch.image | opensearchproject/opensearch:3.3.2 | | Using this key, user must provide the docker image name to setup the stateful deployment of `opensearch`. (must be set when `services.opensearch.local_setup=true`) |
| services.opensearch.pullPolicy | IfNotPresent | | Using this key, user can set the pull policy for the stateful deployment of `opensearch`. (must be set when `services.opensearch.local_setup=true`) |
| services.opensearch.servicePort | 9200 | | This key sets the default port number to be used while setting up stateful deployment of `opensearch`. |
| services.opensearch.volumeSize | 5Gi | | While setting up the stateful deployment, while creating the persistant volume, volume allocation size need to be provided. This key helps you set the volume allocation size. Unit of this value must be in Mi (megabyte) or Gi (gigabyte) |
| services.opensearch.username | plane | | Credentials are requried to access the hosted stateful deployment of `opensearch`. Use this key to set the username for the stateful deployment. |
| services.opensearch.password | Secure@Pass#123!%^&* | | Credentials are requried to access the hosted stateful deployment of `opensearch`. Use this key to set the password for the stateful deployment. |
| services.opensearch.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |
| services.opensearch.nodeSelector | {} | | This key allows you to set the node selector for the stateful deployment of `opensearch`. This is useful when you want to run the deployment on specific nodes in your Kubernetes cluster. |
| services.opensearch.tolerations | [] | | This key allows you to set the tolerations for the stateful deployment of `opensearch`. This is useful when you want to run the deployment on nodes with specific taints in your Kubernetes cluster. |
| services.opensearch.affinity | {} | | This key allows you to set the affinity rules for the stateful deployment of `opensearch`. This is useful when you want to control how pods are scheduled on nodes in your Kubernetes cluster. |
| services.opensearch.labels | {} | | This key allows you to set custom labels for the stateful deployment of `opensearch`. This is useful for organizing and selecting resources in your Kubernetes cluster. |
| services.opensearch.annotations | {} | | This key allows you to set custom annotations for the stateful deployment of `opensearch`. This is useful for adding metadata or configuration hints to your resources. |
| env.opensearch_remote_url | | | Users can also decide to use the remote hosted service and link to Plane deployment. Ignoring all the above keys, set `services.opensearch.local_setup` to `false` and set this key with remote connection url. |
| env.opensearch_remote_username | | | Username for remote OpenSearch service. Required when `services.opensearch.local_setup=false` and `env.opensearch_remote_url` is set. Note: This is not a secret and should be configured in values.yaml, not in external secrets. |
| env.opensearch_remote_password | | | Password for remote OpenSearch service. Required when `services.opensearch.local_setup=false` and `env.opensearch_remote_url` is set. This can be configured in values.yaml or provided via external secrets (`opensearch_existingSecret` with `OPENSEARCH_PASSWORD`). |
| env.opensearch_index_prefix | | | Prefix to be used for OpenSearch indices. This helps organize indices in a multi-tenant or multi-environment setup. |

### Doc Store (Minio/S3) Setup

| Setting | Default | Required | Description |
Expand Down Expand Up @@ -507,6 +529,8 @@ To configure the external secrets for your application, you need to define speci
| pgdb_existingSecret | `POSTGRES_PASSWORD` | Required if `postgres.local_setup=true` | Password for PostgreSQL database | `plane` |
| | `POSTGRES_DB` | Required if `postgres.local_setup=true` | Name of the PostgreSQL database | `plane` |
| | `POSTGRES_USER` | Required if `postgres.local_setup=true` | PostgreSQL user | `plane` |
| opensearch_existingSecret | `OPENSEARCH_PASSWORD` | Required if OpenSearch is enabled | Password for OpenSearch | **local setup**: `Secure@Pass#123!%^&*` <br> <br> **remote setup**: `your_remote_password` |
| | `OPENSEARCH_INITIAL_ADMIN_PASSWORD` | Required if `opensearch.local_setup=true` | Initial admin password for local OpenSearch | `Secure@Pass#123!%^&*` |
| doc_store_existingSecret | `USE_MINIO` | Yes | Flag to enable MinIO as the storage backend | `1` |
| | `MINIO_ROOT_USER` | Yes | MinIO root user | `admin` |
| | `MINIO_ROOT_PASSWORD` | Yes | MinIO root password | `password` |
Expand All @@ -520,6 +544,11 @@ To configure the external secrets for your application, you need to define speci
| | `REDIS_URL` | Yes | Redis URL | `redis://plane-redis.plane-ns.svc.cluster.local:6379/` |
| | `DATABASE_URL` | Yes | PostgreSQL connection URL | **k8s service example**: `postgresql://plane:plane@plane-pgdb.plane-ns.svc.cluster.local:5432/plane` <br> <br>**external service example**: `postgresql://username:password@your-db-host:5432/plane` |
| | `AMQP_URL` | Yes | RabbitMQ connection URL | **k8s service example**: `amqp://plane:plane@plane-rabbitmq.plane-ns.svc.cluster.local:5672/` <br> <br> **external service example**: `amqp://username:password@your-rabbitmq-host:5672/` |
| | `OPENSEARCH_PASSWORD` | Required if OpenSearch is enabled | Password for OpenSearch | **local setup**: `Secure@Pass#123!%^&*` <br> <br> **remote setup**: `your_remote_password` |
| | `OPENSEARCH_ENABLED` | Yes | Flag to enable OpenSearch | `1` (enabled) or `0` (disabled) |
| | `OPENSEARCH_URL` | Required if OpenSearch is enabled | OpenSearch connection URL | **k8s service example**: `http://plane-opensearch.plane-ns.svc.cluster.local:9200` <br> <br> **external service example**: `https://your-opensearch-host:9200` |
| | `OPENSEARCH_USERNAME` | Required if OpenSearch is enabled | Username for OpenSearch | **local setup**: `plane` <br> <br> **remote setup**: `your_remote_username` |
| | `OPENSEARCH_INDEX_PREFIX` | Optional | Prefix for OpenSearch indices | `plane_` |
| live_env_existingSecret | `REDIS_URL` | Yes | Redis URL | `redis://plane-redis.plane-ns.svc.cluster.local:6379/` |
| silo_env_existingSecret | `SILO_HMAC_SECRET_KEY` | Yes | Silo HMAC secret Key | `<random-32-bit-string>` |
| | `REDIS_URL` | Yes | Redis URL | `redis://plane-redis.plane-ns.svc.cluster.local:6379/` |
Expand Down
66 changes: 66 additions & 0 deletions charts/plane-enterprise/questions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -895,6 +895,72 @@ questions:
type: string
show_if: "services.rabbitmq.local_setup=false"

- variable: services.opensearch.local_setup
label: "Install OpenSearch"
type: boolean
default: true
group: "OpenSearch Setup"
# show_subquestion_if: true
subquestions:
- variable: services.opensearch.image
label: "Docker Image"
type: string
default: "opensearchproject/opensearch:3.3.2"
show_if: "services.opensearch.local_setup=true"
- variable: services.opensearch.pullPolicy
label: "OpenSearch Pull Policy"
type: enum
options:
- "Always"
- "IfNotPresent"
- "Never"
default: "IfNotPresent"
show_if: "services.opensearch.local_setup=true"
- variable: services.opensearch.servicePort
label: Service Port
type: int
default: 9200
show_if: "services.opensearch.local_setup=true"
- variable: services.opensearch.volumeSize
label: "Volume Size"
type: string
default: "5Gi"
show_if: "services.opensearch.local_setup=true"
- variable: services.opensearch.username
label: "Username"
type: string
default: "plane"
show_if: "services.opensearch.local_setup=true"
- variable: services.opensearch.password
label: "Password"
type: password
default: "Secure@Pass#123!%^&*"
show_if: "services.opensearch.local_setup=true"
- variable: services.opensearch.assign_cluster_ip
label: "Assign Cluster IP"
type: boolean
default: false
show_if: "services.opensearch.local_setup=true"
- variable: env.opensearch_remote_url
label: "OpenSearch Remote URL"
type: string
default: ""
show_if: "services.opensearch.local_setup=false"
- variable: env.opensearch_remote_username
label: "OpenSearch Remote Username"
type: string
default: ""
show_if: "services.opensearch.local_setup=false"
- variable: env.opensearch_remote_password
label: "OpenSearch Remote Password"
type: password
default: ""
show_if: "services.opensearch.local_setup=false"
- variable: env.opensearch_index_prefix
label: "Index Prefix"
type: string
default: ""

- variable: services.minio.local_setup
label: "Install Minio"
type: boolean
Expand Down
Loading