Skip to content
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

docs(argo-rollouts): add more description for notification secret creation #2922

Merged
merged 6 commits into from
Sep 16, 2024
Merged

docs(argo-rollouts): add more description for notification secret creation #2922

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
75d86f8
docs(argo-rollouts): add more description for secret creation
st-myk Sep 15, 2024
053776b
docs(argo-rollouts): bump chart version
st-myk Sep 15, 2024
0289965
docs(argo-rollouts): fix lint
st-myk Sep 15, 2024
bddc81d
docs(argo-rollouts): change reference to controller
st-myk Sep 15, 2024
0d4d6cb
docs(argo-rollouts): fix readme
st-myk Sep 16, 2024
af2c615
Merge branch 'main' into docs/upd-description-for-secret-creation
yu-croco Sep 16, 2024
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
6 changes: 3 additions & 3 deletions charts/argo-rollouts/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
appVersion: v1.7.2
description: A Helm chart for Argo Rollouts
name: argo-rollouts
version: 2.37.6
version: 2.37.7
home: https://github.com/argoproj/argo-helm
icon: https://argoproj.github.io/argo-rollouts/assets/logo.png
keywords:
Expand All @@ -18,5 +18,5 @@ annotations:
fingerprint: 2B8F22F57260EFA67BE1C5824B11F800CD9D2252
url: https://argoproj.github.io/argo-helm/pgp_keys.asc
artifacthub.io/changes: |
- kind: changed
description: add loadBalancerClass field for Service resources
- kind: added
description: add description for manual secret creation
3 changes: 2 additions & 1 deletion charts/argo-rollouts/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,8 @@ notifications:
create: true

secret:
# -- Whether to create notifications secret
# -- Whether to create notifications secret.
## If you want to manually create secret, do not forget to add proper label to it: "app.kubernetes.io/component: rollouts-controller".
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your PR.
nits; The label in secret is app.kubernetes.io/component: {{ .Values.controller.component }}, so it's not always true that rollouts-controller is the right value. 🤔
Ref: https://github.com/argoproj/argo-helm/blob/argo-rollouts-2.37.6/charts/argo-rollouts/templates/controller/notifications-secret.yaml#L14

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, I will proceed with referencing the {{ .Values.controller.component }} then

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @st-myk
thank you your update. Please run ./scripts/helm-docs.sh to pass CI, as following below, the PR description.

I have updated the documentation according to documentation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your patience 🙂

create: false
# -- Generic key:value pairs to be inserted into the notifications secret
items: {}
Expand Down
Loading