opensearch-devops icon indicating copy to clipboard operation
opensearch-devops copied to clipboard

[Customize opensearch deployment annotation through values.yaml]

Open prathaptce opened this issue 2 years ago • 1 comments
trafficstars

What/Why

What are you proposing?

Now the helm chart deployment annotations cannot be templated through "values.yaml" file. Allowing the Users to provide their custom deployment annotations in values.yaml , deployment of OpenSearch can be controlled based on the deployment condition. (eg. DR, HA setup) rather than customizing the Helm charts themselves.

What users have asked for this feature?

Our network management software uses OpenSearch for logging and monitoring

What problems are you trying to solve?

Currently, OpenSearch deployment is not customizable using values.yaml . I'm trying to add deployment annotation in the values.yaml , which will be used by the deployment.yaml and configures the metadata annotation of the deployment.

Use case: In the DR site deployments, we want to control the deployment of OpenSearch based on a few Deployment annotations. which is not possible now as deployment annotations cannot be passed through values.yaml

What is the developer experience going to be?

Changes will be there only in Helm values.yaml & deployment.yaml file.

Are there any security considerations?

No

Are there any breaking changes to the API

No

What is the user experience going to be?

User can tune the deployment based on his/her needs by adding deployment annotations

Are there breaking changes to the User Experience?

No

Why should it be built? Any reason not to?

Without this feature, we are forced to privately clone the helm chart & customize the deployment.yaml. which is difficult in maintaining whenever we are upgrading to the latest releases.

What will it take to execute?

Low risk in this change. Just making the helm chart updates. Improving the user experience by allowing the custom deployment options

Any remaining open questions?

No

prathaptce avatar Mar 20 '23 11:03 prathaptce

The PR to fix the issue is under review.

Divyaasm avatar Mar 28 '23 19:03 Divyaasm

https://github.com/opensearch-project/helm-charts/pull/407

gaiksaya avatar Aug 23 '24 23:08 gaiksaya