Skip to content

Allow disabling cert-generator with a Helm value #4186

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −1
Open

Allow disabling cert-generator with a Helm value #4186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion charts/nginx-gateway-fabric/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,10 +195,11 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri

| Key | Description | Type | Default |
|-----|-------------|------|---------|
| `certGenerator` | The certGenerator section contains the configuration for the cert-generator Job. | object | `{"affinity":{},"agentTLSSecretName":"agent-tls","annotations":{},"nodeSelector":{},"overwrite":false,"serverTLSSecretName":"server-tls","tolerations":[],"topologySpreadConstraints":[],"ttlSecondsAfterFinished":30}` |
| `certGenerator` | The certGenerator section contains the configuration for the cert-generator Job. | object | `{"affinity":{},"agentTLSSecretName":"agent-tls","annotations":{},"enable":true,"nodeSelector":{},"overwrite":false,"serverTLSSecretName":"server-tls","tolerations":[],"topologySpreadConstraints":[],"ttlSecondsAfterFinished":30}` |
| `certGenerator.affinity` | The affinity of the cert-generator pod. | object | `{}` |
| `certGenerator.agentTLSSecretName` | The name of the base Secret containing TLS CA, certificate, and key for the NGINX Agent to securely communicate with the NGINX Gateway Fabric control plane. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway). | string | `"agent-tls"` |
| `certGenerator.annotations` | The annotations of the cert-generator Job. | object | `{}` |
| `certGenerator.enable` | Enable the cert-generator Job, if this is disabled, then cert-manager or some other method must be used to create the Secrets. | bool | `true` |
| `certGenerator.nodeSelector` | The nodeSelector of the cert-generator pod. | object | `{}` |
| `certGenerator.overwrite` | Overwrite existing TLS Secrets on startup. | bool | `false` |
| `certGenerator.serverTLSSecretName` | The name of the Secret containing TLS CA, certificate, and key for the NGINX Gateway Fabric control plane to securely communicate with the NGINX Agent. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway). | string | `"server-tls"` |
Expand Down
2 changes: 2 additions & 0 deletions charts/nginx-gateway-fabric/templates/certs-job.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{{- if .Values.certGenerator.disable }}
Copy link
Collaborator

Choose a reason for hiding this comment

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

This field needs to be updated to enable.

apiVersion: v1
kind: ServiceAccount
metadata:
Expand Down Expand Up @@ -172,3 +173,4 @@ spec:
{{- toYaml .Values.certGenerator.nodeSelector | nindent 8 }}
{{- end }}
ttlSecondsAfterFinished: {{ .Values.certGenerator.ttlSecondsAfterFinished }}
{{- end }}
7 changes: 7 additions & 0 deletions charts/nginx-gateway-fabric/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@
"title": "annotations",
"type": "object"
},
"enable": {
"default": true,
"description": "Enable the cert-generator Job, if this is disabled, then cert-manager or some other method must be used to create the Secrets.",
"required": [],
"title": "enable",
"type": "boolean"
},
"nodeSelector": {
"description": "The nodeSelector of the cert-generator pod.",
"required": [],
Expand Down
2 changes: 2 additions & 0 deletions charts/nginx-gateway-fabric/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,6 +672,8 @@ nginx:

# -- The certGenerator section contains the configuration for the cert-generator Job.
certGenerator:
# -- Enable the cert-generator Job, if this is disabled, then cert-manager or some other method must be used to create the Secrets.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# -- Enable the cert-generator Job, if this is disabled, then cert-manager or some other method must be used to create the Secrets.
# -- Enable the cert-generator Job. If this is disabled, then cert-manager or some other method must be used to create the required Secrets.

enable: true
# -- The annotations of the cert-generator Job.
annotations: {}

Expand Down