Skip to content

Commit 5258d75

Browse files
committed
Add notes about CRDs requirement
1 parent 951c106 commit 5258d75

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ $ helm repo update
3737

3838
### Installing the CRDs
3939

40-
By default, the Ingress Controller requires a number of custom resource definitions (CRDs) installed in the cluster. The Helm client will install those CRDs.
40+
By default, the Ingress Controller requires a number of custom resource definitions (CRDs) installed in the cluster. The Helm client will install those CRDs. If the CRDs are not installed, the Ingress Controller pods will not become `Ready`.
4141

42-
If you do not use the custom resources that require those CRDs (which corresponds to `controller.enableCustomResources` set to `false` and `controller.appprotect.enable` set to `false`). The installation of the CRDs can be skipped by specifying `--skip-crds` for the helm install command.
42+
If you do not use the custom resources that require those CRDs (which corresponds to `controller.enableCustomResources` set to `false` and `controller.appprotect.enable` set to `false`), the installation of the CRDs can be skipped by specifying `--skip-crds` for the helm install command.
4343

4444
### Installing via Helm Repository
4545

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

+2
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ In this section, we create resources common for most of the Ingress Controller i
5757
5858
### Create Custom Resources
5959
60+
> **Note**: By default, it is required to create custom resource definitions for VirtualServer, VirtualServerRoute, TransportServer and Policy. Otherwise, the Ingress Controller pods will not become `Ready`. If you'd like to disable that requirement, configure [`-enable-custom-resources`](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments#cmdoption-global-configuration) command-line argument to `false` and skip this section.
61+
6062
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:
6163
```
6264
$ kubectl apply -f common/crds/k8s.nginx.org_virtualservers.yaml

0 commit comments

Comments
 (0)