8000 Fix Helm Chart Schema for priorityClassName (#3448) · nginx/kubernetes-ingress@c5cfbc6 · GitHub
[go: up one dir, main page]
Skip to content

Commit c5cfbc6

Browse files
lucacomelucacome
committed
Fix Helm Chart Schema for priorityClassName (#3448)
* Fix Chart Schema for priorityClassName * Fix IC capitalization in docs (cherry picked from commit d51a554)
1 parent 6788836 commit c5cfbc6

File tree

8 files changed

+17
-19
lines changed

8 files changed

+17
-19
lines changed

‎deployments/helm-chart/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ $ kubectl delete -f crds/
140140

141141
If you are running multiple Ingress Controller releases in your cluster with enabled custom resources, the releases will share a single version of the CRDs. As a result, make sure that the Ingress Controller versions match the version of the CRDs. Additionally, when uninstalling a release, ensure that you don’t remove the CRDs until there are no other Ingress Controller releases running in the cluster.
142142

143-
See [running multiple ingress controllers](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/) for more details.
143+
See [running multiple Ingress Controllers](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/) for more details.
144144

145145
## Configuration
146146

@@ -166,7 +166,7 @@ Parameter | Description | Default
166166
`controller.config.name` | The name of the ConfigMap used by the Ingress Controller. | Autogenerated
167167
`controller.config.annotations` | The annotations of the Ingress Controller configmap. | {}
168168
`controller.config.entries` | The entries of the ConfigMap for customizing NGINX configuration. See [ConfigMap resource docs](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/) for the list of supported ConfigMap keys. | {}
169-
`controller.customPorts` | A list of custom ports to expose on the NGINX ingress controller pod. Follows the conventional Kubernetes yaml syntax for container ports. | []
169+
`controller.customPorts` | A list of custom ports to expose on the NGINX Ingress Controller pod. Follows the conventional Kubernetes yaml syntax for container ports. | []
170170
`controller.defaultTLS.cert` | The base64-encoded TLS certificate for the default HTTPS server. **Note:** By default, a pre-generated self-signed certificate is used. It is recommended that you specify your own certificate. Alternatively, omitting the default server secret completely will configure NGINX to reject TLS connections to the default server. | A pre-generated self-signed certificate.
171171
`controller.defaultTLS.key` | The base64-encoded TLS key for the default HTTPS server. **Note:** By default, a pre-generated key is used. It is recommended that you specify your own key. Alternatively, omitting the default server secret completely will configure NGINX to reject TLS connections to the default server. | A pre-generated key.
172172
`controller.defaultTLS.secret` | The secret with a TLS certificate and key for the default HTTPS server. The value must follow the following format: `<namespace>/<name>`. Used as an alternative to specifying a certificate and key using `controller.defaultTLS.cert` and `controller.defaultTLS.key` parameters. **Note:** Alternatively, omitting the default server secret completely will configure NGINX to reject TLS connections to the default server. | None

‎deployments/helm-chart/values.schema.json‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@
222222
"customPorts": {
223223
"type": "array",
224224
"default": [],
225-
"title": "The customPorts to expose on the NGINX ingress controller pod",
225+
"title": "The customPorts to expose on the NGINX Ingress Controller pod",
226226
"items": {
227227
"type": "object",
228228
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort"
@@ -1161,12 +1161,10 @@
11611161
]
11621162
},
11631163
"priorityClassName": {
1164-
"type": "null",
1165-
"default": null,
1164+
"type": "string",
1165+
"default": "",
11661166
"title": "The priorityClassName",
1167-
"examples": [
1168-
null
1169-
]
1167+
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName"
11701168
},
11711169
"readyStatus": {
11721170
"type": "object",
@@ -1353,7 +1351,7 @@
13531351
"annotations": {},
13541352
"extraLabels": {}
13551353
},
1356-
"priorityClassName": null,
1354+
"priorityClassName": "",
13571355
"readyStatus": {
13581356
"enable": true,
13591357
"port": 8081,
@@ -1655,7 +1653,7 @@
16551653
"annotations": {},
16561654
"extraLabels": {}
16571655
},
1658-
"priorityClassName": null,
1656+
"priorityClassName": "",
16591657
"readyStatus": {
16601658
"enable": true,
16611659
"port": 8081,

‎deployments/helm-chart/values.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ controller:
4747
## The log level of the Ingress Controller.
4848
logLevel: 1
4949

50-
## A list of custom ports to expose on the NGINX ingress controller pod. Follows the conventional Kubernetes yaml syntax for container ports.
50+
## A list of custom ports to expose on the NGINX Ingress Controller pod. Follows the conventional Kubernetes yaml syntax for container ports.
5151
customPorts: []
5252

5353
image:
@@ -397,8 +397,8 @@ controller:
397397
## The additional extra labels of the Ingress Controller pod.
398398
extraLabels: {}
399399

400-
## The PriorityClass of the ingress controller pods.
401-
priorityClassName:
400+
## The PriorityClass of the Ingress Controller pods.
401+
# priorityClassName: ""
402402

403403
readyStatus:
404404
## Enables readiness endpoint "/nginx-ready". The endpoint returns a success code when NGINX has loaded all the config after startup.

‎docs/content/installation/installation-with-helm.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ $ kubectl delete -f crds/
135135

136136
If you are running multiple Ingress Controller releases in your cluster with enabled custom resources, the releases will share a single version of the CRDs. As a result, make sure that the Ingress Controller versions match the version of the CRDs. Additionally, when uninstalling a release, ensure that you don’t remove the CRDs until there are no other Ingress Controller releases running in the cluster.
137137

138-
See [running multiple ingress controllers](/nginx-ingress-controller/installation/running-multiple-ingress-controllers/) for more details.
138+
See [running multiple Ingress Controllers](/nginx-ingress-controller/installation/running-multiple-ingress-controllers/) for more details.
139139

140140
## Configuration
141141

@@ -166,7 +166,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
166166
|``controller.config.name`` | The name of the ConfigMap used by the Ingress Controller. | Autogenerated |
167167
|``controller.config.annotations`` | The annotations of the Ingress Controller configmap. | {} |
168168
|``controller.config.entries`` | The entries of the ConfigMap for customizing NGINX configuration. See [ConfigMap resource docs](/nginx-ingress-controller/configuration/global-configuration/configmap-resource/) for the list of supported ConfigMap keys. | {} |
169-
|``controller.customPorts`` | A list of custom ports to expose on the NGINX ingress controller pod. Follows the conventional Kubernetes yaml syntax for container ports. | [] |
169+
|``controller.customPorts`` | A list of custom ports to expose on the NGINX Ingress Controller pod. Follows the conventional Kubernetes yaml syntax for container ports. | [] |
170170
|``controller.defaultTLS.cert`` | The base64-encoded TLS certificate for the default HTTPS server. **Note:** By default, a pre-generated self-signed certificate is used. It is recommended that you specify your own certificate. Alternatively, omitting the default server secret completely will configure NGINX to reject TLS connections to the default server. See the [default-server-tls-secret command-line argument](/nginx-ingress-controller/configuration/global-configuration/command-line-#cmdoption-default-server-tls-secret) for more details. | A pre-generated self-signed certificate. |
171171
|``controller.defaultTLS.key`` | The base64-encoded TLS key for the default HTTPS server. **Note:** By default, a pre-generated key is used. It is recommended that you specify your own key. Alternatively, omitting the default server secret completely will configure NGINX to reject TLS connections to the default server. See the [default-server-tls-secret command-line argument](/nginx-ingress-controller/configuration/global-configuration/command-line-#cmdoption-default-server-tls-secret) for more details. | A pre-generated key. |
172172
|``controller.defaultTLS.secret`` | The secret with a TLS certificate and key for the default HTTPS server. The value must follow the following format: ``<namespace>/<name>``. Used as an alternative to specifying a certificate and key using ``controller.defaultTLS.cert`` and ``controller.defaultTLS.key`` parameters. **Note:** Alternatively, omitting the default server secret completely will configure NGINX to reject TLS connections to the default server. See the [default-server-tls-secret command-line argument](/nginx-ingress-controller/configuration/global-configuration/command-line-#cmdoption-default-server-tls-secret) for more details. | None |

‎docs/content/releases.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ OVERVIEW:
136136
* VirtualServer resource now supports [wildcard hostname](https://kubernetes.io/docs/concepts/services-networking/ingress/#hostname-wildcards).
137137
* NGINX Ingress Controller images including the combined NGINX AppProtect WAF and NGINX AppProtect DoS solutions are now published to our registry. See [Images with NGINX Plus](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/#images-with-nginx-plus) for a detailed list of images in our registry.
138138
* Added support for watching multiple namespaces using the [-watch-namespace](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#-watch-namespace-string) cli argument. This can configured by passing a comma-separated list of namespaces to the `-watch-namespace` CLI argument (e.g. `-watch-namespace=ns-1,ns-2`).
139-
* A new cli argument has been added: [-include-year](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#-include-year). This appends the current year to the log output from the ingress controller. Example output: `I20220512 09:20:42.345457`.
139+
* A new cli argument has been added: [-include-year](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#-include-year). This appends the current year to the log output from the Ingress Controller. Example output: `I20220512 09:20:42.345457`.
140140
* Post-startup configuration reloads have been optimized to reduce traffic impacts. When many resources are modified at the same time, changes are combined to reduce the number of data plane reloads.
141141

142142
FEATURES:

‎docs/content/tutorials/nginx-ingress-istio.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ docs: "DOCS-889"
1010

1111
## Using NGINX Ingress Controller with Istio service mesh
1212

13-
NGINX Ingress Controller can now be used as the ingress controller for applications running inside an Istio service mesh. This allows you to continue using the advanced capabilities that NGINX IC provides on Istio-based environments without resorting to any workarounds.
13+
NGINX Ingress Controller can now be used as the Ingress Controller for applications running inside an Istio service mesh. This allows you to continue using the advanced capabilities that NGINX IC provides on Istio-based environments without resorting to any workarounds.
1414
This is accomplished using the special setting [use-cluster-ip](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#upstream) for the backend.
1515

1616

‎internal/k8s/controller.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3850,7 +3850,7 @@ func (lbc *LoadBalancerController) getServiceForIngressBackend(backend *networki
38503850
return nil, fmt.Errorf("service %s doesn't exist", svcKey)
38513851
}
38523852

3853-
// HasCorrectIngressClass checks if resource ingress class annotation (if exists) or ingressClass string for VS/VSR is matching with ingress controller class
3853+
// HasCorrectIngressClass checks if resource ingress class annotation (if exists) or ingressClass string for VS/VSR is matching with Ingress Controller class
38543854
func (lbc *LoadBalancerController) HasCorrectIngressClass(obj interface{}) bool {
38553855
var class string
38563856
switch obj := obj.(type) {

‎pkg/apis/externaldns/validation/externaldns.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func isFullyQualifiedDomainName(name string) error {
111111
var (
112112
// validRecords represents allowed DNS record names
113113
//
114-
// NGINX ingress controller at the moment supports
114+
// NGINX Ingress Controller at the moment supports
115115
// a subset of DNS record types listed in the external-dns project.
116116
validRecords = []string{"A", "CNAME", "AAAA"}
117117

0 commit comments

Comments
 (0)
0