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

[wallrj]

We use the nameOverride field in the values.yaml of the Venafi enterprise plugin for approver-policy, to change the name of the Kubernetes resources deployed by the sub-chart.
But the new Helm JSON schema validation doesn't include that field, resulting in the following error:

  Release "approver-policy-enterprise" does not exist. Installing it now.
  Error: values don't meet the specifications of the schema(s) in the following chart(s):
  cert-manager-approver-policy:
  - (root): Additional property nameOverride is not allowed
...

nameOverride is a standard field that is created by helm create, but it is not documented in the scaffolded chart.

• https://github.com/helm/helm/blob/e007c900ce5f2233c8583565d5ba1b0433b1a213/pkg/chartutil/create.go#L433-L449

const defaultHelpers = `{{/*
Expand the name of the chart.
*/}}
{{- define "<CHARTNAME>.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
{{- end }}


{{/*
Create a default fully qualified app name.
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
If release name contains chart name it will be used as a full name.
*/}}
{{- define "<CHARTNAME>.fullname" -}}
{{- if .Values.fullnameOverride }}
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
{{- else }}
{{- $name := default .Chart.Name .Values.nameOverride }}
{{- if contains $name .Release.Name }}
{{- .Release.Name | trunc 63 | trimSuffix "-" }}
{{- else }}
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
{{- end }}
{{- end }}
{{- end }}

Our version is here:

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 -}}

There's another standard field called fullNameOverride which is added by helm create but which is missing from the approver-policy chart, and I don't know why.
The purpose of these fields are explained here:

• https://stackoverflow.com/questions/63838705/what-is-the-difference-between-fullnameoverride-and-nameoverride-in-helm

Relatedly while learning more about this field I found that @smuda has reported a problem with the nameOverride field, but I haven't investigated that here.

• Setting .Values.nameOverride makes the pod not have rights to update secret cert-manager-approver-policy-tls #207

[wallrj]

See

• https://stackoverflow.com/a/63839389

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 -}}

[inteon]

Thanks for the fix @wallrj
/approve
/lgtm

[jetstack-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: inteon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [inteon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment