Skip to content

Commit 8efe718

Browse files
authored
NLB-6992 NGINXaaS for Azure connectivity tool (#1164)
* Updated NGINXaaS Load Balancer for Kubernetes version to latest * NLB-6992 Added documentation for the NGINXaaS connectivity tool Added a get-help section and added the existing get-help doc to it as "support". Grouped the connectivity tool with it.
1 parent ae37c86 commit 8efe718

File tree

4 files changed

+36
-4
lines changed

4 files changed

+36
-4
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Get help
3+
weight: 700
4+
draft: false
5+
url: /nginxaas/azure/get-help/
6+
---
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Connectivity test tool
3+
weight: 200
4+
toc: true
5+
url: /nginxaas/azure/get-help/connectivity
6+
type:
7+
- how-to
8+
---
9+
10+
Use the connectivity test tool to determine whether a specific IP address is accessible from your deployment's dataplane. The connectivity test tool accepts an IP address and a port number. It uses [`netcat`](https://nc110.sourceforge.io/) to open a TCP connection with the given address, without sending any data to the address. The tool returns `netcat`'s output to the user. This is useful for debugging connectivity issues and determining if a problem is in NGINX configuration or Azure network configuration.
11+
12+
To use the tool:
13+
14+
- Retrieve your [data plane API endpoint]({{< ref "/nginxaas-azure/loadbalancer-kubernetes.md#nginxaas-data-plane-api-endpoint" >}}).
15+
16+
- Create an [API key]({{< ref "/nginxaas-azure/loadbalancer-kubernetes.md#create-an-nginxaas-data-plane-api-key" >}}) if you do not already have one.
17+
18+
- Append the `/connectivity` suffix to your deployment's data plane API endpoint, e.g. https://my-deployment.my-region.nginxaas.net/connectivity. Use a browser to navigate to this URL.
19+
20+
- The browser will prompt you for a username and password. The username is optional. Please enter your API key in the password field.
21+
22+
- You will then be able to use the connectivity tool through the browser.
23+
24+
{{< call-out "note" >}}
25+
The connectivity test tool will not accept loopback or multicast IP addresses.
26+
{{< /call-out >}}

content/nginxaas-azure/get-help.md renamed to content/nginxaas-azure/get-help/support.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Get help
3-
weight: 750
2+
title: Support
3+
weight: 100
44
toc: true
55
nd-docs: DOCS-882
6-
url: /nginxaas/azure/get-help/
6+
url: /nginxaas/azure/get-help/support
77
type:
88
- how-to
99
---

content/nginxaas-azure/loadbalancer-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The NLK controller can be installed in your Kubernetes cluster using either Helm
148148
Install the NLK controller using `helm install`. Be sure your kubectl context is pointed at the desired cluster.
149149

150150
```shell
151-
helm install nlk oci://registry-1.docker.io/nginxcharts/nginxaas-loadbalancer-kubernetes --version 1.1.1 \
151+
helm install nlk oci://registry-1.docker.io/nginxcharts/nginxaas-loadbalancer-kubernetes --version 1.2.3 \
152152
--set "nlk.dataplaneApiKey=${keyValue}" \
153153
--set "nlk.config.nginxHosts=${dataplaneAPIEndpoint}nplus" \
154154
--set "nlk.config.tls.mode=ca-tls"

0 commit comments

Comments
 (0)