From 5258d7534f33d2354960eed475b6020e58d4afaa Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Tue, 23 Mar 2021 16:42:25 -0700 Subject: [PATCH] Add notes about CRDs requirement --- docs-web/installation/installation-with-helm.md | 4 ++-- docs-web/installation/installation-with-manifests.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs-web/installation/installation-with-helm.md b/docs-web/installation/installation-with-helm.md index f0210413e1..46e2fae28e 100644 --- a/docs-web/installation/installation-with-helm.md +++ b/docs-web/installation/installation-with-helm.md @@ -37,9 +37,9 @@ $ helm repo update ### Installing the CRDs -By default, the Ingress Controller requires a number of custom resource definitions (CRDs) installed in the cluster. The Helm client will install those CRDs. +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`. -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. +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. ### Installing via Helm Repository diff --git a/docs-web/installation/installation-with-manifests.md b/docs-web/installation/installation-with-manifests.md index 99bc2837bc..b10ecbc42c 100644 --- a/docs-web/installation/installation-with-manifests.md +++ b/docs-web/installation/installation-with-manifests.md @@ -57,6 +57,8 @@ In this section, we create resources common for most of the Ingress Controller i ### Create Custom Resources +> **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. + 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/crds/k8s.nginx.org_virtualservers.yaml