Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document option for installing CRDs from a single remote yaml #4730

Merged
merged 9 commits into from
Dec 6, 2023
+102 −36
Merged

Document option for installing CRDs from a single remote yaml #4730

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
54704fd
Document option for installing CRDs from a single remote yaml
shaun-nx Dec 1, 2023
63b9890
Merge branch 'main' into docs/single-crd
shaun-nx Dec 1, 2023
dae8409
Update references to deployments directory and fix references to CRDs
shaun-nx Dec 5, 2023
7b75867
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 5, 2023
6b6524a
Merge branch 'main' into docs/single-crd
shaun-nx Dec 5, 2023
d5ef7a7
Merge branch 'main' into docs/single-crd
shaun-nx Dec 5, 2023
1ede111
Merge branch 'main' into docs/single-crd
shaun-nx Dec 5, 2023
c1f47b4
Merge branch 'main' into docs/single-crd
shaun-nx Dec 5, 2023
d2e768f
Fix reference link
shaun-nx Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 35 additions & 8 deletions docs/content/installation/installing-nic/installation-with-manifests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,40 +58,67 @@ This guide assumes you are using the latest release.

To make sure your NGINX Ingress Controller pods reach the `Ready` state, you'll need to create custom resource definitions (CRDs) for various components. Alternatively, you can disable this requirement by setting the `-enable-custom-resources` command-line argument to `false`.

shaun-nx marked this conversation as resolved.
Show resolved Hide resolved
{{<tabs name="crd-install">}}

{{%tab name="Install CRDs from single YAML"%}}

### Core custom resource definitions

1. Create CRDs for [VirtualServer and VirtualServerRoute]({{< relref "configuration/virtualserver-and-virtualserverroute-resources.md" >}}), [TransportServer]({{< relref "configuration/transportserver-resource.md" >}}), and [Policy]({{< relref "configuration/policy-resource.md" >}}):
1. Create CRDs for [VirtualServer and VirtualServerRoute]({{< relref "configuration/virtualserver-and-virtualserverroute-resources.md" >}}), [TransportServer]({{< relref "configuration/transportserver-resource.md" >}}), [Policy]({{< relref "configuration/policy-resource.md" >}}) and [GlobalConfiguration]({{< relref "configuration/global-configuration/globalconfiguration-resource.md" >}}):

```shell
kubectl apply -f common/crds/k8s.nginx.org_virtualservers.yaml
kubectl apply -f common/crds/k8s.nginx.org_virtualserverroutes.yaml
kubectl apply -f common/crds/k8s.nginx.org_transportservers.yaml
kubectl apply -f common/crds/k8s.nginx.org_policies.yaml
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.3.2/deploy/crds.yaml
vepatel marked this conversation as resolved.
Show resolved Hide resolved
```

### Optional custom resource definitions

1. (Optional) For TCP and UDP load balancing, create a cCRD for [GlobalConfiguration]({{< relref "configuration/global-configuration/globalconfiguration-resource.md" >}}):
1. For the NGINX App Protect WAF module, create CRDs for `APPolicy`, `APLogConf` and `APUserSig`:

```shell
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.3.2/deploy/crds-nap-waf.yaml
```

2. For the NGINX App Protect DoS module, create CRDs for `APDosPolicy`, `APDosLogConf` and `DosProtectedResource`:

```shell
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.3.2/deploy/crds-nap-dos.yaml
```

{{%/tab%}}

{{%tab name="Install CRDs from cloning the repo"%}}
shaun-nx marked this conversation as resolved.
Show resolved Hide resolved

### Core custom resource definitions

1. Create CRDs for [VirtualServer and VirtualServerRoute]({{< relref "configuration/virtualserver-and-virtualserverroute-resources.md" >}}), [TransportServer]({{< relref "configuration/transportserver-resource.md" >}}), [Policy]({{< relref "configuration/policy-resource.md" >}}) and [GlobalConfiguration]({{< relref "configuration/global-configuration/globalconfiguration-resource.md" >}}):

```shell
kubectl apply -f common/crds/k8s.nginx.org_virtualservers.yaml
shaun-nx marked this conversation as resolved.
Show resolved Hide resolved
kubectl apply -f common/crds/k8s.nginx.org_virtualserverroutes.yaml
kubectl apply -f common/crds/k8s.nginx.org_transportservers.yaml
kubectl apply -f common/crds/k8s.nginx.org_policies.yaml
kubectl apply -f common/crds/k8s.nginx.org_globalconfigurations.yaml
```
### Optional custom resource definitions

2. (Optional) For the NGINX App Protect WAF module, create CRDs for `APPolicy`, `APLogConf` and `APUserSig`:
1. For the NGINX App Protect WAF module, create CRDs for `APPolicy`, `APLogConf` and `APUserSig`:

```shell
kubectl apply -f common/crds/appprotect.f5.com_aplogconfs.yaml
shaun-nx marked this conversation as resolved.
Show resolved Hide resolved
kubectl apply -f common/crds/appprotect.f5.com_appolicies.yaml
kubectl apply -f common/crds/appprotect.f5.com_apusersigs.yaml
```

3. (Optional) For the NGINX App Protect DoS module, create CRDs for `APDosPolicy`, `APDosLogConf` and `DosProtectedResource`:
2. For the NGINX App Protect DoS module, create CRDs for `APDosPolicy`, `APDosLogConf` and `DosProtectedResource`:

```shell
kubectl apply -f common/crds/appprotectdos.f5.com_apdoslogconfs.yaml
kubectl apply -f common/crds/appprotectdos.f5.com_apdospolicy.yaml
kubectl apply -f common/crds/appprotectdos.f5.com_dosprotectedresources.yaml
```
{{%/tab%}}

{{</tabs>}}

---

Expand Down
Loading