Add forward proxy support to mgmt config (#7560)

Author: AlexFenlon

Makefile

@@ -2,7 +2,7 @@
 VER = $(shell grep IC_VERSION .github/data/version.txt | cut -d '=' -f 2)
 GIT_TAG = $(shell git describe --exact-match --tags || echo untagged)
 VERSION = $(VER)-SNAPSHOT
-NGINX_PLUS_VERSION ?= R34
+NGINX_PLUS_VERSION  ?= R34
 PLUS_ARGS = --build-arg NGINX_PLUS_VERSION=$(NGINX_PLUS_VERSION) --secret id=nginx-repo.crt,src=nginx-repo.crt --secret id=nginx-repo.key,src=nginx-repo.key
 
 # Variables that can be overridden

charts/nginx-ingress/templates/controller-configmap.yaml

@@ -58,6 +58,9 @@ data:
 {{- if hasKey .Values.controller.mgmt.usageReport "interval" }}
  usage-report-interval: {{ quote .Values.controller.mgmt.usageReport.interval }}
 {{- end }}
+{{- if hasKey .Values.controller.mgmt.usageReport "proxyHost" }}
+ usage-report-proxy-host: {{ quote .Values.controller.mgmt.usageReport.proxyHost }}
+{{- end }}
 {{- end }}
 {{- if hasKey .Values.controller.mgmt "sslTrustedCertificateSecretName" }}
  ssl-trusted-certificate-secret-name: {{ quote .Values.controller.mgmt.sslTrustedCertificateSecretName }}

charts/nginx-ingress/templates/controller-daemonset.yaml

@@ -126,6 +126,23 @@ spec:
  valueFrom:
  fieldRef:
  fieldPath: spec.serviceAccountName
+{{- end }}
+{{- if hasKey .Values.controller.mgmt "usageReport" -}}
+{{- if hasKey .Values.controller.mgmt.usageReport "proxyCredentialsSecretName" }}
+{{- if not (hasKey .Values.controller.mgmt.usageReport "proxyHost") -}}
+{{- fail "Error: 'controller.mgmt.usageReport.proxyHost' must be set when using 'controller.mgmt.usageReport.proxyCredentialsSecretName'." }}
+{{- end }}
+ - name: PROXY_USER
+ valueFrom:
+ secretKeyRef:
+ name: {{ .Values.controller.mgmt.usageReport.proxyCredentialsSecretName }}
+ key: username
+ - name: PROXY_PASS
+ valueFrom:
+ secretKeyRef:
+ name: {{ .Values.controller.mgmt.usageReport.proxyCredentialsSecretName }}
+ key: password
+{{- end }}
 {{- end }}
  resources:
 {{ toYaml .Values.controller.resources | indent 10 }}

charts/nginx-ingress/templates/controller-deployment.yaml

@@ -135,6 +135,23 @@ spec:
  valueFrom:
  fieldRef:
  fieldPath: spec.serviceAccountName
+{{- end }}
+{{- if hasKey .Values.controller.mgmt "usageReport" -}}
+{{- if hasKey .Values.controller.mgmt.usageReport "proxyCredentialsSecretName" }}
+{{- if not (hasKey .Values.controller.mgmt.usageReport "proxyHost") -}}
+{{- fail "Error: 'controller.mgmt.usageReport.proxyHost' must be set when using 'controller.mgmt.usageReport.proxyCredentialsSecretName'." }}
+{{- end }}
+ - name: PROXY_USER
+ valueFrom:
+ secretKeyRef:
+ name: {{ .Values.controller.mgmt.usageReport.proxyCredentialsSecretName }}
+ key: username
+ - name: PROXY_PASS
+ valueFrom:
+ secretKeyRef:
+ name: {{ .Values.controller.mgmt.usageReport.proxyCredentialsSecretName }}
+ key: password
+{{- end }}
 {{- end }}
  args:
 {{- include "nginx-ingress.args" . | nindent 10 }}

charts/nginx-ingress/values.schema.json

@@ -142,6 +142,29 @@
  "1h",
  "24h"
  ]
+ },
+ "proxyHost": {
+ "type": "string",
+ "title": "The proxy hostname with optional port",
+ "default": "",
+ "examples": [
+ "proxy.example.com",
+ "proxy.local",
+ "proxy",
+ "192.168.1.254",
+ "proxy.example.com:3128",
+ "proxy.local:3128",
+ "proxy:3128",
+ "192.168.1.254:3128"
+ ]
+ },
+ "proxyCredentialsSecretName": {
+ "type": "string",
+ "default": "",
+ "title": "The secret containing the proxy username/password combination. Must contain a `username` and `password` field",
+ "examples": [
+ "proxy-credentials"
+ ]
  }
  }
  },

charts/nginx-ingress/values.yaml

@@ -25,6 +25,8 @@ controller:
  # usageReport:
  # endpoint: "product.connect.nginx.com" # Endpoint for usage report
  # interval: 1h
+ # proxyHost: "proxy.example.com:3138" # Proxy server for usage report, with optional port
+ # proxyCredentialsSecretName: "proxy-credentials" # Secret containing proxy credentials, must contain a `username` and `password` field
 
  ## Configures the ssl_verify directive in the mgmt block
  # sslVerify: true