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

Jump to bottom

Document the nameOverride Helm chart value and add it to the JSON schema #390

Merged
merged 4 commits into from
Mar 1, 2024
Merged

Document the nameOverride Helm chart value and add it to the JSON schema #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7d88625
Remove the lint exception for nameOverride
wallrj Mar 1, 2024
b3c9a72
Document the nameOverride value
wallrj Mar 1, 2024
7163d6d
make generate-helm-docs
wallrj Mar 1, 2024
8123c06
make generate-helm-schema
wallrj Mar 1, 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
4 changes: 4 additions & 0 deletions deploy/charts/approver-policy/README.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions deploy/charts/approver-policy/values.linter.exceptions
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
value missing from values.yaml: nameOverride

# Some false postives
# See https://github.com/cert-manager/helm-tool/issues/27
value missing from templates: tolerations
Expand Down
7 changes: 7 additions & 0 deletions deploy/charts/approver-policy/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
"imagePullSecrets": {
"$ref": "#/$defs/helm-values.imagePullSecrets"
},
"nameOverride": {
"$ref": "#/$defs/helm-values.nameOverride"
},
"nodeSelector": {
"$ref": "#/$defs/helm-values.nodeSelector"
},
Expand Down Expand Up @@ -384,6 +387,10 @@
"items": {},
"type": "array"
},
"helm-values.nameOverride": {
"description": "nameOverride replaces the name of the chart in the Chart.yaml file, when this is used to construct Kubernetes object names.",
"type": "string"
},
"helm-values.nodeSelector": {
"default": {},
"description": "The nodeSelector on Pods tells Kubernetes to schedule Pods on the nodes with matching labels. For more information, see [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/).",
Expand Down
5 changes: 5 additions & 0 deletions deploy/charts/approver-policy/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# nameOverride replaces the name of the chart in the Chart.yaml file, when this
# is used to construct Kubernetes object names.
# +docs:property
# nameOverride: approver-policy
Copy link
Member Author

Choose a reason for hiding this comment

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

See

approver-policy/deploy/charts/approver-policy/templates/_helpers.tpl

Lines 1 to 6 in c1b51af

{{/*
Expand the name of the chart.
*/}}
{{- define "cert-manager-approver-policy.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
{{- end -}}


crds:
# This option decides if the CRDs should be installed
# as part of the Helm installation.
Expand Down