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

Jump to bottom

Re-order and adjust custom resource headings for installation via manifest #3141

Merged
merged 2 commits into from
Oct 12, 2022
Merged

Re-order and adjust custom resource headings for installation via manifest #3141

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6eddc91
feat: Re-order and adjust custom resource headings
ADubhlaoich Oct 10, 2022
2de95bd
Merge branch 'main' into kic-997
ADubhlaoich Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 14 additions & 17 deletions docs/content/installation/installation-with-manifests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,41 +70,38 @@ In this section, we create resources common for most of the Ingress Controller i

**Note**: The Ingress Controller will fail to start without an IngressClass resource.

### Create Custom Resources
## 3. 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
$ 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
```

If you would like to use the TCP and UDP load balancing features of the Ingress Controller, create the following additional resources:
1. Create a custom resource definition for [GlobalConfiguration](/nginx-ingress-controller/configuration/global-configuration/globalconfiguration-resource) resource:
```
$ kubectl apply -f common/crds/k8s.nginx.org_globalconfigurations.yaml
```
2. If you would like to use the TCP and UDP load balancing features of the Ingress Controller, create the following additional resources:

### Resources for NGINX App Protect

If you would like to use the App Protect WAF module, create the following additional resources:
Create a custom resource definition for [GlobalConfiguration](/nginx-ingress-controller/configuration/global-configuration/globalconfiguration-resource) resource:

$ kubectl apply -f common/crds/k8s.nginx.org_globalconfigurations.yaml

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

1. Create a custom resource definition for `APPolicy`, `APLogConf` and `APUserSig`:
Create a custom resource definition for `APPolicy`, `APLogConf` and `APUserSig`:

```
$ kubectl apply -f common/crds/appprotect.f5.com_aplogconfs.yaml
$ kubectl apply -f common/crds/appprotect.f5.com_appolicies.yaml
$ kubectl apply -f common/crds/appprotect.f5.com_apusersigs.yaml
```

### Resources for NGINX App Protect DoS

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

1. Create a custom resource definition for `APDosPolicy`, `APDosLogConf` and `DosProtectedResource`:
Create a custom resource definition for `APDosPolicy`, `APDosLogConf` and `DosProtectedResource`:

```
$ kubectl apply -f common/crds/appprotectdos.f5.com_apdoslogconfs.yaml
Expand All @@ -121,11 +118,11 @@ We include two options for deploying the Ingress Controller:
> Before creating a Deployment or Daemonset resource, make sure to update the [command-line arguments](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments) of the Ingress Controller container in the corresponding manifest file according to your requirements.

### Deploy Arbitrator for NGINX App Protect DoS
If you would like to use the App Protect DoS module, need to add arbitrator deployment.
If you would like to use the App Protect DoS module, you will need to deploy the Arbitrator.

* build your own image and push it to your private Docker registry by following the instructions from [here](/nginx-ingress-controller/app-protect-dos/installation#Build-the-app-protect-dos-arb-Docker-Image).
* Build your own image and push it to your private Docker registry by following the instructions from [here](/nginx-ingress-controller/app-protect-dos/installation#Build-the-app-protect-dos-arb-Docker-Image).

* run the Arbitrator by using a Deployment and Service
* Run the Arbitrator by using a Deployment and Service

```
$ kubectl apply -f deployment/appprotect-dos-arb.yaml
Expand Down