Skip to content

Commit

Permalink
Fix Helm Chart Schema for priorityClassName (#3448)
Browse files Browse the repository at this point in the history
* Fix Chart Schema for priorityClassName

* Fix IC capitalization in docs
  • Loading branch information
lucacome authored Jan 18, 2023
1 parent 7ae1260 commit d51a554
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 19 deletions.
4 changes: 2 additions & 2 deletions deployments/helm-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ $ kubectl delete -f crds/

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.

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

## Configuration

Expand All @@ -166,7 +166,7 @@ Parameter | Description | Default
`controller.config.name` | The name of the ConfigMap used by the Ingress Controller. | Autogenerated
`controller.config.annotations` | The annotations of the Ingress Controller configmap. | {}
`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. | {}
`controller.customPorts` | A list of custom ports to expose on the NGINX ingress controller pod. Follows the conventional Kubernetes yaml syntax for container ports. | []
`controller.customPorts` | A list of custom ports to expose on the NGINX Ingress Controller pod. Follows the conventional Kubernetes yaml syntax for container ports. | []
`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.
`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.
`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
Expand Down
14 changes: 6 additions & 8 deletions deployments/helm-chart/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@
"customPorts": {
"type": "array",
"default": [],
"title": "The customPorts to expose on the NGINX ingress controller pod",
"title": "The customPorts to expose on the NGINX Ingress Controller pod",
"items": {
"type": "object",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort"
Expand Down Expand Up @@ -1161,12 +1161,10 @@
]
},
"priorityClassName": {
"type": "null",
"default": null,
"type": "string",
"default": "",
"title": "The priorityClassName",
"examples": [
null
]
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName"
},
"readyStatus": {
"type": "object",
Expand Down Expand Up @@ -1353,7 +1351,7 @@
"annotations": {},
"extraLabels": {}
},
"priorityClassName": null,
"priorityClassName": "",
"readyStatus": {
"enable": true,
"port": 8081,
Expand Down Expand Up @@ -1655,7 +1653,7 @@
"annotations": {},
"extraLabels": {}
},
"priorityClassName": null,
"priorityClassName": "",
"readyStatus": {
"enable": true,
"port": 8081,
Expand Down
6 changes: 3 additions & 3 deletions deployments/helm-chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ controller:
## The log level of the Ingress Controller.
logLevel: 1

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

image:
Expand Down Expand Up @@ -397,8 +397,8 @@ controller:
## The additional extra labels of the Ingress Controller pod.
extraLabels: {}

## The PriorityClass of the ingress controller pods.
priorityClassName:
## The PriorityClass of the Ingress Controller pods.
# priorityClassName: ""

readyStatus:
## Enables readiness endpoint "/nginx-ready". The endpoint returns a success code when NGINX has loaded all the config after startup.
Expand Down
4 changes: 2 additions & 2 deletions docs/content/installation/installation-with-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ $ kubectl delete -f crds/

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.

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

## Configuration

Expand Down Expand Up @@ -166,7 +166,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
|``controller.config.name`` | The name of the ConfigMap used by the Ingress Controller. | Autogenerated |
|``controller.config.annotations`` | The annotations of the Ingress Controller configmap. | {} |
|``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. | {} |
|``controller.customPorts`` | A list of custom ports to expose on the NGINX ingress controller pod. Follows the conventional Kubernetes yaml syntax for container ports. | [] |
|``controller.customPorts`` | A list of custom ports to expose on the NGINX Ingress Controller pod. Follows the conventional Kubernetes yaml syntax for container ports. | [] |
|``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. |
|``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. |
|``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 |
Expand Down
2 changes: 1 addition & 1 deletion docs/content/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ OVERVIEW:
* VirtualServer resource now supports [wildcard hostname](https://kubernetes.io/docs/concepts/services-networking/ingress/#hostname-wildcards).
* 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.
* 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`).
* 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`.
* 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`.
* 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.

FEATURES:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/tutorials/nginx-ingress-istio.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ docs: "DOCS-889"

## Using NGINX Ingress Controller with Istio service mesh

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


Expand Down
2 changes: 1 addition & 1 deletion internal/k8s/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -3850,7 +3850,7 @@ func (lbc *LoadBalancerController) getServiceForIngressBackend(backend *networki
return nil, fmt.Errorf("service %s doesn't exist", svcKey)
}

// HasCorrectIngressClass checks if resource ingress class annotation (if exists) or ingressClass string for VS/VSR is matching with ingress controller class
// HasCorrectIngressClass checks if resource ingress class annotation (if exists) or ingressClass string for VS/VSR is matching with Ingress Controller class
func (lbc *LoadBalancerController) HasCorrectIngressClass(obj interface{}) bool {
var class string
switch obj := obj.(type) {
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/externaldns/validation/externaldns.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ func isFullyQualifiedDomainName(name string) error {
var (
// validRecords represents allowed DNS record names
//
// NGINX ingress controller at the moment supports
// NGINX Ingress Controller at the moment supports
// a subset of DNS record types listed in the external-dns project.
validRecords = []string{"A", "CNAME", "AAAA"}

Expand Down

0 comments on commit d51a554

Please sign in to comment.