You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/content/how-to/monitoring/troubleshooting.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,10 +29,10 @@ To resolve this issue you will need to set `allowPrivilegeEscalation` to `true`.
29
29
30
30
#### Description
31
31
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:
33
33
34
34
`usage reporting not enabled`
35
35
36
36
#### Resolution
37
37
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.
{{< 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 >}}
45
45
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 >}}
@@ -93,13 +93,13 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps.
93
93
94
94
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:
Copy file name to clipboardExpand all lines: site/content/installation/usage-reporting.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,22 +8,22 @@ docs: "DOCS-000"
8
8
9
9
## Overview
10
10
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.
12
12
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.
14
14
15
15
## Requirements
16
16
17
-
Usage reporting needs to be configured when deploying NGINX Gateway Fabric.
17
+
Usage Reporting needs to be configured when deploying NGINX Gateway Fabric.
18
18
19
-
To enable usage reporting, you must have the following:
19
+
To enable Usage Reporting, you must have the following:
20
20
21
21
- NGINX Gateway Fabric 1.2.0 or later
22
22
-[NGINX Instance Manager 2.11](https://docs.nginx.com/nginx-management-suite) or later
23
23
24
24
In addition to the software requirements, you will need:
25
25
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.
27
27
- Access to the Kubernetes cluster where NGINX Gateway Fabric is deployed, with the ability to deploy a Kubernetes Secret.
28
28
29
29
## Adding a User Account to NGINX Instance Manager
@@ -34,7 +34,7 @@ In addition to the software requirements, you will need:
34
34
- Feature: NGINX Plus Usage
35
35
- Access: CRUD
36
36
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.
38
38
39
39
## Enabling Usage Reporting in NGINX Gateway Fabric
40
40
@@ -67,9 +67,9 @@ To make the credentials available to NGINX Gateway Fabric to connect to the NGIN
67
67
68
68
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.
69
69
70
-
### Install NGINX Gateway Fabric with usage reporting enabled
70
+
### Install NGINX Gateway Fabric with Usage Reporting enabled
71
71
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:
73
73
74
74
If using Helm, the `nginx.usage` values should be set as necessary:
0 commit comments