Customize opensearch deployment annotation through values.yaml #407

prathaptce · 2023-03-21T15:16:41Z

Description

[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.]

Issues Resolved

[https://github.com/opensearch-project/opensearch-devops/issues/115]

Check List

Commits are signed per the DCO using --signoff

For any changes to files within Helm chart directories:

Helm chart version bumped
Helm chart CHANGELOG.md updated to reflect change

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

prathaptce

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

prathaptce · 2023-03-22T13:52:35Z

@bbarani , Hi, I'm new to this review process. I have submitted the changes needed for customizing the OpenSearch deployment. Can someone review these changes? thanks

prudhvigodithi · 2023-03-22T14:53:28Z

Hey @prathaptce thanks for the contribution, please check the following points.

The DCO check is missing, please make sure the commits are signed.
The Helm chart version has to be bumped (sample PR).
The CHANGELOG.md has to be recorded along with if required updating README.md.

Apart from this I will review the technical aspects of the chart shortly, thank you.

prathaptce · 2023-03-23T04:20:54Z

Hey @prathaptce thanks for the contribution, please check the following points.

The DCO check is missing, please make sure the commits are signed.

The Helm chart version has to be bumped (sample PR).

The CHANGELOG.md has to be recorded along with if required updating README.md.

Apart from this I will review the technical aspects of the chart shortly, thank you.

Now, DCO check is passing, helm chart version is bumped & 'CHANGELOG.md' is updated with the changes done for this PR

prudhvigodithi · 2023-03-23T15:58:14Z

charts/opensearch/values.yaml

@@ -131,6 +131,9 @@ image:

 podAnnotations: {}
  # iam.amazonaws.com/role: es-cluster
+
+# Deployment annotations
+annotations: {}


Hey Can we please use as openSearchAnnotations?, also please change the comment to # OpenSearch Statefulset annotations
Thank you

Changed to openSearchAnnotations & comments to stateful set annotations

prudhvigodithi · 2023-03-23T15:58:42Z

charts/opensearch-dashboards/values.yaml

@@ -67,6 +67,9 @@ secretMounts: []

 podAnnotations: {}

+# Deployment annotations
+annotations: {}


Hey Can we please use as dashboardAnnotations?

Addressed this comment as well

prudhvigodithi · 2023-03-23T15:59:35Z

Hey @prathaptce apart from my previous suggestions, can you take care of the lint errors also please update the README files in the chart with the new annotation changes.
Thank you

prudhvigodithi · 2023-03-23T16:00:05Z

charts/opensearch-dashboards/templates/deployment.yaml

@@ -3,6 +3,10 @@ kind: Deployment
 metadata:
  name: {{ template "opensearch-dashboards.fullname" . }}
  labels: {{- include "opensearch-dashboards.labels" . | nindent 4 }}
+  {{- with .Values.annotations }}


Would be as dashboardAnnotations.

made the necessary changes here as well

prudhvigodithi · 2023-03-23T16:00:28Z

charts/opensearch/templates/statefulset.yaml

@@ -7,6 +7,9 @@ metadata:
    {{- include "opensearch.labels" . | nindent 4 }}
  annotations:
    majorVersion: "{{ include "opensearch.majorVersion" . }}"
+    {{- with .Values.annotations }}


Would be as openSearchAnnotations.

incorporated the changes

prathaptce · 2023-03-24T06:09:38Z

Hey @prathaptce apart from my previous suggestions, can you take care of the lint errors also please update the README files in the chart with the new annotation changes. Thank you

I'm not able to execute ct lint locally, is there a way I can trigger the ct lint job in GitHub & check the error? I'm not sure which line is creating the lint error

Signed-off-by: Zelin Hao <zelinhao@amazon.com> Signed-off-by: Zelin Hao <zelinhao@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

…oject#356) Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

* Resolve Kind Cluster not able to be built in PR checks Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Fix the kindest/node versions on docker images Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

…oject#358) Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

…opensearch-project#342) * allow adding plugins and change defaultmode for opensearch dashboards yaml file Signed-off-by: Lu Yu <nluyu@amazon.com> * bump version and update changelog Signed-off-by: Lu Yu <nluyu@amazon.com> * add new line Signed-off-by: Lu Yu <nluyu@amazon.com> * bump version for os Signed-off-by: Lu Yu <nluyu@amazon.com> * resolve conflict in changelog Signed-off-by: Lu Yu <nluyu@amazon.com> * trigger build Signed-off-by: Lu Yu <nluyu@amazon.com> Signed-off-by: Lu Yu <nluyu@amazon.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

…earch-project#344) * fix securityConfig.path Signed-off-by: Ruslan Gainanov <gromrx1@gmail.com> * add link to issue Signed-off-by: Ruslan Gainanov <gromrx1@gmail.com> Signed-off-by: Ruslan Gainanov <gromrx1@gmail.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

* Update appVersion to 2.4.1 Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> * Update appVersion to 2.4.1 Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> * Fix changelog Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> * Fix changelog Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> * Fix version Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

…t#336) Signed-off-by: Christian Kuhn <phello@gmx.de> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

opensearch-project#367) Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Signed-off-by: Rishabh Singh <sngri@amazon.com> Signed-off-by: Rishabh Singh <sngri@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

prathaptce · 2023-03-24T14:54:14Z

prudhvigodithi

@prudhvigodithi, I have addressed all the comments. Let me know if the lint error still exists. thanks

prudhvigodithi · 2023-03-24T15:07:01Z

charts/opensearch-dashboards/CHANGELOG.md

@@ -13,6 +13,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 ---
+## [2.9.2]
+### Added
+- Added custom opensearch deployment annotation through values.yaml 


[NIT] Thanks @prathaptce noticed one more, please check

Added custom opensearch and dashboard annotations through values.yaml.

thanks. updated the same

Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

prudhvigodithi · 2023-03-24T15:19:42Z

Thanks @prathaptce , @TheAlgo and @peterzhuamazon can you please review ?
Thank you

prathaptce · 2023-03-27T03:56:09Z

Thanks @prathaptce , @TheAlgo and @peterzhuamazon can you please review ? Thank you

@TheAlgo @peterzhuamazon, can you please review? thank you

prudhvigodithi · 2023-03-29T18:07:32Z

Hey @prathaptce I did notice one thing the Chary.yaml file is not incremented, sample PR https://github.com/opensearch-project/helm-charts/pull/375/files, can you please check.

Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

prathaptce · 2023-03-29T18:12:45Z

Hey @prathaptce I did notice one thing the Chary.yaml file is not incremented, sample PR https://github.com/opensearch-project/helm-charts/pull/375/files, can you please check.

Just now pumped up the version numbers in Chart.yaml. Please check now

prudhvigodithi · 2023-03-29T18:17:50Z

Pinging @TheAlgo and @peterzhuamazon :)

prathaptce · 2023-03-30T04:22:16Z

hi @TheAlgo @peterzhuamazon, Can you please review the changes & let me know your comments?

prathaptce · 2023-04-04T02:20:24Z

Can this PR merged? if no other comments. thanks

prudhvigodithi · 2023-04-04T04:08:10Z

Hey @TheAlgo @peterzhuamazon please add your approval. Thanks for your patience @prathaptce
Thank you

TheAlgo · 2023-04-22T15:41:44Z

Hey @TheAlgo @peterzhuamazon please add your approval. Thanks for your patience @prathaptce Thank you

Will check this week. Apologies for delays.

TheAlgo

LGTM!

prathaptce · 2023-04-24T03:11:09Z

@TheAlgo .Thank you. Can you please merge this PR?

bbarani · 2023-04-24T04:26:40Z

Merging the PR as its approved.

prudhvigodithi · 2023-04-24T13:08:17Z

Hey @prathaptce can you please backport to 1.x? as I see this feature is useful for 1.x version as well.
Thank you

prathaptce · 2023-04-25T06:31:14Z

Sure @prudhvigodithi, I will raise the PR for 1.x as well

prathaptce requested review from bbarani, TheAlgo, DandyDeveloper, peterzhuamazon, prudhvigodithi and gaiksaya as code owners March 21, 2023 15:16

prathaptce commented Mar 21, 2023

View reviewed changes

prathaptce changed the title ~~Prathaptce patch 1 1~~ Customize opensearch deployment annotation through values.yaml Mar 22, 2023

prathaptce force-pushed the prathaptce-patch-1-1 branch from 05da68f to e67418e Compare March 23, 2023 04:01

prudhvigodithi reviewed Mar 23, 2023

View reviewed changes

prudhvigodithi requested changes Mar 23, 2023

View reviewed changes

prathaptce force-pushed the prathaptce-patch-1-1 branch from a151749 to a24b1b8 Compare March 24, 2023 07:46

zelinh and others added 13 commits March 24, 2023 13:22

Update appVersion for 2.4.0 release (opensearch-project#350)

1778eb5

Signed-off-by: Zelin Hao <zelinhao@amazon.com> Signed-off-by: Zelin Hao <zelinhao@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Add .whitesource configuration file (opensearch-project#353)

7bcb231

Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Resolve Kind Cluster not able to be built in PR checks (opensearch-pr…

87434d3

…oject#356) Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Resolve Kind Cluster not able to be built in PR checks (opensearch-pr…

8cc47ad

…oject#358) Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Fix version for OpenSearch

b417319

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Fix version for OpenSearch-Dasboards

93fa81e

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Add hostPort support for http- and transport-ports (opensearch-projec…

c3a6fd0

…t#336) Signed-off-by: Christian Kuhn <phello@gmx.de> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Updated MAINTAINERS.md to match recommended opensearch-project format. (

5d8f377

opensearch-project#367) Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

Bump OS and OSD version to 2.5.0 (opensearch-project#373)

18a29bc

Signed-off-by: Rishabh Singh <sngri@amazon.com> Signed-off-by: Rishabh Singh <sngri@amazon.com> Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

prathaptce requested review from prudhvigodithi and removed request for gaiksaya, peterzhuamazon and bbarani March 24, 2023 08:50

prudhvigodithi reviewed Mar 24, 2023

View reviewed changes

Updated the changelog message

47a172f

Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

prudhvigodithi self-requested a review March 24, 2023 15:18

prudhvigodithi approved these changes Mar 24, 2023

View reviewed changes

Merge branch 'main' into prathaptce-patch-1-1

ad01026

prudhvigodithi self-requested a review March 29, 2023 18:07

Updating the version number

4181432

Signed-off-by: prathaptce <86703966+prathaptce@users.noreply.github.com>

prudhvigodithi approved these changes Mar 29, 2023

View reviewed changes

TheAlgo approved these changes Apr 22, 2023

View reviewed changes

bbarani merged commit d5c3493 into opensearch-project:main Apr 24, 2023

prathaptce mentioned this pull request Apr 29, 2023

Backport 1.x : Customize opensearch deployment annotation through values.… #422

Merged

3 tasks

gaiksaya mentioned this pull request Aug 23, 2024

[Customize opensearch deployment annotation through values.yaml] opensearch-project/opensearch-devops#115

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Customize opensearch deployment annotation through values.yaml #407

Customize opensearch deployment annotation through values.yaml #407

prathaptce commented Mar 21, 2023 •

edited

Loading

prathaptce left a comment

prathaptce commented Mar 22, 2023

prudhvigodithi commented Mar 22, 2023

prathaptce commented Mar 23, 2023

prudhvigodithi Mar 23, 2023

prathaptce Mar 24, 2023

prudhvigodithi Mar 23, 2023

prathaptce Mar 24, 2023

prudhvigodithi commented Mar 23, 2023

prudhvigodithi Mar 23, 2023

prathaptce Mar 24, 2023

prudhvigodithi Mar 23, 2023

prathaptce Mar 24, 2023

prathaptce commented Mar 24, 2023

prathaptce commented Mar 24, 2023

prudhvigodithi Mar 24, 2023

prathaptce Mar 24, 2023

prudhvigodithi commented Mar 24, 2023

prathaptce commented Mar 27, 2023

prudhvigodithi commented Mar 29, 2023

prathaptce commented Mar 29, 2023

prudhvigodithi commented Mar 29, 2023 •

edited

Loading

prathaptce commented Mar 30, 2023

prathaptce commented Apr 4, 2023

prudhvigodithi commented Apr 4, 2023

TheAlgo commented Apr 22, 2023

TheAlgo left a comment

prathaptce commented Apr 24, 2023

bbarani commented Apr 24, 2023

prudhvigodithi commented Apr 24, 2023

prathaptce commented Apr 25, 2023

Customize opensearch deployment annotation through values.yaml #407

Customize opensearch deployment annotation through values.yaml #407

Conversation

prathaptce commented Mar 21, 2023 • edited Loading

Description

Issues Resolved

Check List

prathaptce left a comment

Choose a reason for hiding this comment

prathaptce commented Mar 22, 2023

prudhvigodithi commented Mar 22, 2023

prathaptce commented Mar 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prudhvigodithi commented Mar 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prathaptce commented Mar 24, 2023

prathaptce commented Mar 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prudhvigodithi commented Mar 24, 2023

prathaptce commented Mar 27, 2023

prudhvigodithi commented Mar 29, 2023

prathaptce commented Mar 29, 2023

prudhvigodithi commented Mar 29, 2023 • edited Loading

prathaptce commented Mar 30, 2023

prathaptce commented Apr 4, 2023

prudhvigodithi commented Apr 4, 2023

TheAlgo commented Apr 22, 2023

TheAlgo left a comment

Choose a reason for hiding this comment

prathaptce commented Apr 24, 2023

bbarani commented Apr 24, 2023

prudhvigodithi commented Apr 24, 2023

prathaptce commented Apr 25, 2023

prathaptce commented Mar 21, 2023 •

edited

Loading

prudhvigodithi commented Mar 29, 2023 •

edited

Loading