Skip to content

Commit 4886651

Browse files
committed
Docs updates
1 parent 4cf456d commit 4886651

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

site/content/how-to/monitoring/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ To resolve this issue you will need to set `allowPrivilegeEscalation` to `true`.
2929

3030
#### Description
3131

32-
If using NGINX Gateway Fabric with NGINX Plus as the data plane, you will see the following error in the _nginx-gateway_ logs if you have not enabled usage reporting:
32+
If using NGINX Gateway Fabric with NGINX Plus as the data plane, you will see the following error in the _nginx-gateway_ logs if you have not enabled Usage Reporting:
3333

3434
`usage reporting not enabled`
3535

3636
#### Resolution
3737

38-
To resolve this issue, enable usage reporting by following the [Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) guide.
38+
To resolve this issue, enable Usage Reporting by following the [Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) guide.

site/content/installation/installing-ngf/helm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,17 @@ To complete this guide, you'll need to install:
3333

3434
To install the latest stable release of NGINX Gateway Fabric in the **nginx-gateway** namespace, run the following command:
3535

36-
- For NGINX:
36+
##### For NGINX
3737

3838
```shell
3939
helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway
4040
```
4141

42-
- For NGINX Plus:
42+
##### For NGINX Plus
4343

4444
{{< note >}}Replace `private-registry.nginx.com` with the proper registry for your NGINX Plus image, and if applicable, replace `nginx-plus-registry-secret` with your Secret name containing the registry credentials.{{< /note >}}
4545

46-
{{< note >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) when installing.{{< /note >}}
46+
{{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) when installing.{{< /important >}}
4747

4848
```shell
4949
helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret --create-namespace -n nginx-gateway

site/content/installation/installing-ngf/manifests.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,35 +53,35 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps.
5353

5454
#### Stable release
5555

56-
- For NGINX:
56+
##### For NGINX
5757

5858
```shell
5959
kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.1.0/nginx-gateway.yaml
6060
```
6161

62-
- For NGINX Plus:
62+
##### For NGINX Plus
6363

6464
Download the [deployment YAML](https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/nginx-plus-gateway.yaml).
6565

6666
Update the `nginx-plus-gateway.yaml` file to include your chosen NGINX Plus image from the F5 Container registry or your custom image.
6767

68-
{{< note >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) before installing.{{< /note >}}
68+
{{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) before applying.{{< /important >}}
6969

7070
```shell
7171
kubectl apply -f nginx-plus-gateway.yaml
7272
```
7373

7474
#### Edge version
7575

76-
- For NGINX:
76+
##### For NGINX
7777

7878
```shell
7979
kubectl apply -f deploy/manifests/nginx-gateway.yaml
8080
```
8181

82-
- For NGINX Plus:
82+
##### For NGINX Plus
8383

84-
{{< note >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) before installing.{{< /note >}}
84+
{{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) before applying.{{< /important >}}
8585

8686
```shell
8787
kubectl apply -f deploy/manifests/nginx-plus-gateway.yaml
@@ -93,13 +93,13 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps.
9393

9494
We support a subset of the additional features provided by the Gateway API experimental channel. To enable the experimental features of Gateway API which are supported by NGINX Gateway Fabric:
9595

96-
- For NGINX:
96+
##### For NGINX
9797

9898
```shell
9999
kubectl apply -f deploy/manifests/nginx-gateway-experimental.yaml
100100
```
101101

102-
- For NGINX Plus
102+
##### For NGINX Plus
103103

104104
```shell
105105
kubectl apply -f deploy/manifests/nginx-plus-gateway-experimental.yaml

site/content/installation/usage-reporting.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ docs: "DOCS-000"
88

99
## Overview
1010

11-
Usage reporting connects to the NGINX Instance Manager and reports the number of Nodes and NGINX Gateway Fabric Pods in the cluster.
11+
Usage Reporting connects to the NGINX Instance Manager and reports the number of Nodes and NGINX Gateway Fabric Pods in the cluster.
1212

13-
To use usage reporting, you must have access to [NGINX Instance Manager](https://www.nginx.com/products/nginx-management-suite/instance-manager). Usage reporting is a requirement of the new Flexible Consumption Program for NGINX Gateway Fabric, used to calculate costs. **This only applies if using NGINX Plus as the data plane.** Usage is reported every 24 hours.
13+
To use Usage Reporting, you must have access to [NGINX Instance Manager](https://www.nginx.com/products/nginx-management-suite/instance-manager). Usage Reporting is a requirement of the new Flexible Consumption Program for NGINX Gateway Fabric, used to calculate costs. **This only applies if using NGINX Plus as the data plane.** Usage is reported every 24 hours.
1414

1515
## Requirements
1616

17-
Usage reporting needs to be configured when deploying NGINX Gateway Fabric.
17+
Usage Reporting needs to be configured when deploying NGINX Gateway Fabric.
1818

19-
To enable usage reporting, you must have the following:
19+
To enable Usage Reporting, you must have the following:
2020

2121
- NGINX Gateway Fabric 1.2.0 or later
2222
- [NGINX Instance Manager 2.11](https://docs.nginx.com/nginx-management-suite) or later
2323

2424
In addition to the software requirements, you will need:
2525

26-
- Access to an NGINX Instance Manager username and password for basic authentication. You will also need the URL of your NGINX Instance Manager system. The usage reporting user account must have access to the `/api/platform/v1/k8s-usage` endpoint.
26+
- Access to an NGINX Instance Manager username and password for basic authentication. You will also need the URL of your NGINX Instance Manager system. The Usage Reporting user account must have access to the `/api/platform/v1/k8s-usage` endpoint.
2727
- Access to the Kubernetes cluster where NGINX Gateway Fabric is deployed, with the ability to deploy a Kubernetes Secret.
2828

2929
## Adding a User Account to NGINX Instance Manager
@@ -34,7 +34,7 @@ In addition to the software requirements, you will need:
3434
- Feature: NGINX Plus Usage
3535
- Access: CRUD
3636

37-
1. Create a user account following the steps in the [Create New Users](https://docs.nginx.com/nginx-management-suite/admin-guides/authentication/basic-authentication/#create-users) section of the NGINX Instance Manager documentation. In step 6, assign the user to the role created above. Note that currently only "Basic Auth" authentication is supported for usage reporting purposes.
37+
1. Create a user account following the steps in the [Create New Users](https://docs.nginx.com/nginx-management-suite/admin-guides/authentication/basic-authentication/#create-users) section of the NGINX Instance Manager documentation. In step 6, assign the user to the role created above. Note that currently only "Basic Auth" authentication is supported for Usage Reporting purposes.
3838

3939
## Enabling Usage Reporting in NGINX Gateway Fabric
4040

@@ -67,9 +67,9 @@ To make the credentials available to NGINX Gateway Fabric to connect to the NGIN
6767
6868
If you need to update the basic-auth credentials at any time, update the `username` and `password` fields and apply the changes. NGINX Gateway Fabric will automatically detect the changes and use the new username and password without redeployment.
6969

70-
### Install NGINX Gateway Fabric with usage reporting enabled
70+
### Install NGINX Gateway Fabric with Usage Reporting enabled
7171

72-
When installing NGINX Gateway Fabric, a few configuration options need to be specified in order to enable usage reporting. You should follow the normal [installation](https://docs.nginx.com/nginx-gateway-fabric/installation/) steps using your preferred method, but ensure you include the following options:
72+
When installing NGINX Gateway Fabric, a few configuration options need to be specified in order to enable Usage Reporting. You should follow the normal [installation](https://docs.nginx.com/nginx-gateway-fabric/installation/) steps using your preferred method, but ensure you include the following options:
7373

7474
If using Helm, the `nginx.usage` values should be set as necessary:
7575

0 commit comments

Comments
 (0)