Skip to content

Commit 8224595

Browse files
Dean-CoakleyRulox
authored andcommitted
Add docs to skip OpenAPI validation
1 parent fdc31b6 commit 8224595

File tree

3 files changed

+25
-2
lines changed

3 files changed

+25
-2
lines changed

deployments/helm-chart/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ $ helm repo update
3939

4040
### Installing the CRDs
4141

42+
**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl create` command below. Otherwise, you will get an error validating data:
43+
```
44+
ValidationError(CustomResourceDefinition.spec): unknown field "preserveUnknownFields" in io.k8s.apiextensions-apiserver.pkg.apis.api extensions.v1beta1.CustomResourceDefinitionSpec
45+
```
46+
4247
By default, the Ingress Controller requires a number of custom resource definitions (CRDs) installed in the cluster. Helm 3.x client will install those CRDs. If you're using a Helm 2.x client, you need to install the CRDs via `kubectl`:
4348

4449
```console
@@ -113,6 +118,8 @@ To install the chart with the release name my-release (my-release is the name th
113118

114119
### Upgrading the CRDs
115120

121+
**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl apply` command below.
122+
116123
Helm does not upgrade the CRDs during a release upgrade. Before you upgrade a release, run the following command to upgrade the CRDs:
117124

118125
```console
@@ -248,7 +255,7 @@ Parameter | Description | Default
248255
`controller.pod.annotations` | The annotations of the Ingress Controller pod. | {}
249256
`controller.appprotect.enable` | Enables the App Protect module in the Ingress Controller. | false
250257
`controller.readyStatus.enable` | Enables the readiness endpoint `"/nginx-ready"`. The endpoint returns a success code when NGINX has loaded all the config after the startup. This also configures a readiness probe for the Ingress Controller pods that uses the readiness endpoint. | true
251-
`controller.readyStaus.port` | The HTTP port for the readiness endpoint. | 8081
258+
`controller.readyStatus.port` | The HTTP port for the readiness endpoint. | 8081
252259
`rbac.create` | Configures RBAC. | true
253260
`prometheus.create` | Expose NGINX or NGINX Plus metrics in the Prometheus format. | false
254261
`prometheus.port` | Configures the port to scrape the metrics. | 9113

docs-web/installation/installation-with-helm.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ $ helm repo update
3737

3838
### Installing the CRDs
3939

40+
**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl create` command below. Otherwise, you will get an error validating data:
41+
```
42+
ValidationError(CustomResourceDefinition.spec): unknown field "preserveUnknownFields" in io.k8s.apiextensions-apiserver.pkg.apis.api extensions.v1beta1.CustomResourceDefinitionSpec
43+
```
44+
4045
By default, the Ingress Controller requires a number of custom resource definitions (CRDs) installed in the cluster. Helm 3.x client will install those CRDs. If you're using a Helm 2.x client, you need to install the CRDs via `kubectl`:
4146

4247
```console
@@ -111,6 +116,8 @@ To install the chart with the release name my-release (my-release is the name th
111116

112117
### Upgrading the CRDs
113118

119+
**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl apply` command below.
120+
114121
Helm does not upgrade the CRDs during a release upgrade. Before you upgrade a release, run the following command to upgrade the CRDs:
115122

116123
```console
@@ -380,7 +387,7 @@ The following tables lists the configurable parameters of the NGINX Ingress cont
380387
* - ``controller.readyStatus.enable``
381388
- Enables the readiness endpoint `"/nginx-ready"`. The endpoint returns a success code when NGINX has loaded all the config after the startup. This also configures a readiness probe for the Ingress Controller pods that uses the readiness endpoint.
382389
- true
383-
* - ``controller.readyStaus.port``
390+
* - ``controller.readyStatus.port``
384391
- The HTTP port for the readiness endpoint.
385392
- 8081
386393
* - ``rbac.create``

docs-web/installation/installation-with-manifests.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ In this section, we create resources common for most of the Ingress Controller i
4747
$ kubectl apply -f common/nginx-config.yaml
4848
```
4949
50+
### Create Custom Resources
51+
52+
**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl apply` commands below. Otherwise, you will get an error validating data:
53+
```
54+
ValidationError(CustomResourceDefinition.spec): unknown field "preserveUnknownFields" in io.k8s.apiextensions-apiserver.pkg.apis.api extensions.v1beta1.CustomResourceDefinitionSpec
55+
```
56+
5057
1. Create custom resource definitions for [VirtualServer and VirtualServerRoute](/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources), [TransportServer](/nginx-ingress-controller/configuration/transportserver-resource) and [Policy](/nginx-ingress-controller/configuration/policy-resource) resources:
5158
```
5259
$ kubectl apply -f common/vs-definition.yaml
@@ -70,6 +77,8 @@ If you would like to use the TCP and UDP load balancing features of the Ingress
7077
7178
### Resources for NGINX App Protect
7279
80+
**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl apply` commands below.
81+
7382
If you would like to use the App Protect module, create the following additional resources:
7483
7584
1. Create a custom resource definition for `APPolicy` and `APLogConf`:

0 commit comments

Comments
 (0)