Skip to content

Commit f06c770

Browse files
committed
NLB-6240 Improve NGINXaaS NLK docs for NGINX Ingress Controller users
This change adds improvements to our NLK installation guide for users of LoadBalancer services and for users of NGINX Ingress Controller.
1 parent 3c3c1b5 commit f06c770

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

content/nginxaas-azure/quickstart/loadbalancer-kubernetes.md

+14
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ The steps in this section must be completed once for each new setup. We will ins
7171

7272
{{<note>}}
7373
The data plane API key has the following requirements:
74+
7475
- The key should have an expiration date. The default expiration date is six months from the date of creation. The expiration date cannot be longer than two years from the date of creation.
7576
- The key should be at least 12 characters long.
7677
- The key requires three out of four of the following types of characters:
@@ -184,6 +185,7 @@ You can also install the NLK controller AKS extension by navigating to [F5 NGINX
184185
- On the **Basics** tab, provide the following information:
185186

186187
{{<bootstrap-table "table table-striped table-bordered">}}
188+
187189
| Field | Description |
188190
|---------------------------- | ---------------------------- |
189191
| Subscription | Select the appropriate Azure subscription. |
@@ -194,6 +196,7 @@ You can also install the NLK controller AKS extension by navigating to [F5 NGINX
194196
- Select **Application Details**, and provide the following information:
195197

196198
{{<bootstrap-table "table table-striped table-bordered">}}
199+
197200
| Field | Description |
198201
|---------------------------- | ---------------------------- |
199202
| Cluster extension resource name | Provide a name for the NLK controller. |
@@ -247,10 +250,18 @@ Expose a Kubernetes `Service` to route traffic to your workload. The `Service`
247250
- Choose one of the following `Service` types:
248251
- `NodePort`: To route external traffic into the cluster using a well defined port exposed on each AKS worker node.
249252
- `ClusterIP`: To route traffic to pods directly if you are running an Azure Container Networking Interface (CNI) that lets you expose the pods on the Azure VNET.
253+
- `LoadBalancer`: To route traffic to the cluster's external load balancer. The load balancer routes traffic into the cluster as normal.
250254
- The port name must be formatted as `{{NGINX Context}}-{{NGINX upstream name}}`. For example:
251255
- If the upstream is in the `http` context and named `my-service` then the name is `http-my-service`
252256
- If the upstream is in the `stream` context and named `jet` then the port name is `stream-jet`
253257

258+
{{< note >}}
259+
**NGINX Ingress Controller users**: if you wish to route traffic from your NGINXaaS deployment to your NGINX Ingress Controller service, please make the following changes to your helm chart values:
260+
261+
- Add `"nginx.com/nginxaas": "nginxaas"` to the NGINX Ingress Controller service annotations.
262+
- Modify the `service.httpPort.name` or `service.httpsPort.name` values to provide the expected port name format, as above.
263+
{{</ note >}}
264+
254265
The following example uses a service of type `NodePort`:
255266

256267
```yaml
@@ -331,6 +342,7 @@ flowchart TB
331342
```
332343

333344
{{<note>}}
345+
334346
- Configuring multiple NLK controllers to update the same upstream isn't supported and will result in unpredictable behavior.
335347
{{</note>}}
336348

@@ -341,6 +353,7 @@ Multiple NLK controllers can be installed in the same AKS cluster to update sepa
341353
Each NLK needs a unique helm release name and needs a unique helm value for `nlk.config.serviceAnnotationMatch`. Each NLK will only watch services that have the matching annotation.
342354

343355
{{<note>}}
356+
344357
- Consider using `helm` to install multiple NLK controllers on an AKS cluster. Installing multiple copies of the controller on the same AKS cluster is not supported via the [AKS Extension](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/f5-networks.f5-nginx-for-azure-aks-extension?tab=overview).
345358
{{</note>}}
346359

@@ -361,6 +374,7 @@ The logs can be made more verbose by setting the Helm value `nlk.config.logLevel
361374
NGINXaaS supports exporting dynamic upstream update logs to an Azure Storage account or to a Log Analytics workspace.
362375

363376
To setup logging:
377+
364378
1. Select **Diagnostic settings** under **Monitoring**.
365379
1. Select **Add diagnostic setting**.
366380
1. On the following panel, provide a **Diagnostic setting name**.

0 commit comments

Comments
 (0)