Skip to content

Commit

Permalink
Add docs to skip OpenAPI validation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dean-Coakley authored and Rulox committed Jul 23, 2020
1 parent fdc31b6 commit 8224595
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 2 deletions.
9 changes: 8 additions & 1 deletion deployments/helm-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ $ helm repo update

### Installing the CRDs

**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:
```
ValidationError(CustomResourceDefinition.spec): unknown field "preserveUnknownFields" in io.k8s.apiextensions-apiserver.pkg.apis.api extensions.v1beta1.CustomResourceDefinitionSpec
```

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`:

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

### Upgrading the CRDs

**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl apply` command below.

Helm does not upgrade the CRDs during a release upgrade. Before you upgrade a release, run the following command to upgrade the CRDs:

```console
Expand Down Expand Up @@ -248,7 +255,7 @@ Parameter | Description | Default
`controller.pod.annotations` | The annotations of the Ingress Controller pod. | {}
`controller.appprotect.enable` | Enables the App Protect module in the Ingress Controller. | false
`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
`controller.readyStaus.port` | The HTTP port for the readiness endpoint. | 8081
`controller.readyStatus.port` | The HTTP port for the readiness endpoint. | 8081
`rbac.create` | Configures RBAC. | true
`prometheus.create` | Expose NGINX or NGINX Plus metrics in the Prometheus format. | false
`prometheus.port` | Configures the port to scrape the metrics. | 9113
Expand Down
9 changes: 8 additions & 1 deletion docs-web/installation/installation-with-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ $ helm repo update

### Installing the CRDs

**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:
```
ValidationError(CustomResourceDefinition.spec): unknown field "preserveUnknownFields" in io.k8s.apiextensions-apiserver.pkg.apis.api extensions.v1beta1.CustomResourceDefinitionSpec
```

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`:

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

### Upgrading the CRDs

**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl apply` command below.

Helm does not upgrade the CRDs during a release upgrade. Before you upgrade a release, run the following command to upgrade the CRDs:

```console
Expand Down Expand Up @@ -380,7 +387,7 @@ The following tables lists the configurable parameters of the NGINX Ingress cont
* - ``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
* - ``controller.readyStaus.port``
* - ``controller.readyStatus.port``
- The HTTP port for the readiness endpoint.
- 8081
* - ``rbac.create``
Expand Down
9 changes: 9 additions & 0 deletions docs-web/installation/installation-with-manifests.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,13 @@ In this section, we create resources common for most of the Ingress Controller i
$ kubectl apply -f common/nginx-config.yaml
```

### Create Custom Resources

**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:
```
ValidationError(CustomResourceDefinition.spec): unknown field "preserveUnknownFields" in io.k8s.apiextensions-apiserver.pkg.apis.api extensions.v1beta1.CustomResourceDefinitionSpec
```

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:
```
$ kubectl apply -f common/vs-definition.yaml
Expand All @@ -70,6 +77,8 @@ If you would like to use the TCP and UDP load balancing features of the Ingress
### Resources for NGINX App Protect

**Note**: If you're using Kubernetes 1.14, make sure to add `--validate=false` to the `kubectl apply` commands below.

If you would like to use the App Protect module, create the following additional resources:

1. Create a custom resource definition for `APPolicy` and `APLogConf`:
Expand Down

0 comments on commit 8224595

Please sign in to comment.