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
Update top level documentation pages for style consistency (#5754)
This commit changes the top level pages of documentation
to adhere with newer style guide conventions.
* Horizontal rules at the end of sections
* Sentence case for page titles and headings
* Note formatting
* Link introduction phrasing
Co-authored-by: Venktesh Shivam Patel <[email protected]>
Copy file name to clipboardExpand all lines: docs/content/overview/about.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,8 @@ This document describes the F5 NGINX Ingress Controller, an Ingress Controller i
10
10
11
11
---
12
12
13
+
---
14
+
13
15
NGINX Ingress Controller is an [Ingress Controller]({{< relref "glossary.md#ingress-controller">}}) implementation for NGINX and NGINX Plus that can load balance Websocket, gRPC, TCP and UDP applications. It supports standard [Ingress]({{< relref "glossary.md#ingress">}}) features such as content-based routing and TLS/SSL termination. Several NGINX and NGINX Plus features are available as extensions to Ingress resources through [Annotations]({{< relref "configuration/ingress-resources/advanced-configuration-with-annotations">}}) and the [ConfigMap]({{< relref "configuration/global-configuration/configmap-resource">}}) resource.
14
16
15
17
NGINX Ingress Controller supports the [VirtualServer and VirtualServerRoute resources]({{< relref "configuration/virtualserver-and-virtualserverroute-resources">}}) as alternatives to Ingress, enabling traffic splitting and advanced content-based routing. It also supports TCP, UDP and TLS Passthrough load balancing using [TransportServer resources]({{< relref "configuration/transportserver-resource">}}).
Copy file name to clipboardExpand all lines: docs/content/overview/product-telemetry.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,32 @@
1
1
---
2
2
title: Product telemetry
3
+
title: Product telemetry
3
4
toc: true
4
5
weight: 500
5
6
---
6
7
7
8
Learn why, what and how F5 NGINX Ingress Controller collects telemetry.
8
9
10
+
---
11
+
Learn why, what and how F5 NGINX Ingress Controller collects telemetry.
12
+
9
13
---
10
14
11
15
## Overview
12
16
17
+
NGINX Ingress Controller collects product telemetry data to allow its developers to understand how it's deployed and configured by users. This data is used to triage development work, prioritizing features and functionality that will benefit the most people.
13
18
NGINX Ingress Controller collects product telemetry data to allow its developers to understand how it's deployed and configured by users. This data is used to triage development work, prioritizing features and functionality that will benefit the most people.
14
19
15
20
Product telemetry is enabled by default, collected once every 24 hours. It's then sent to a service managed by F5 over HTTPS.
16
21
17
22
{{< note >}} If you would prefer not to send any telemetry data, you can [opt-out](#opt-out) when installing NGINX Ingress Controller. {{< /note >}}
18
23
19
24
---
25
+
{{< note >}} If you would prefer not to send any telemetry data, you can [opt-out](#opt-out) when installing NGINX Ingress Controller. {{< /note >}}
20
26
27
+
---
28
+
29
+
## Data collected
21
30
## Data collected
22
31
23
32
These are the data points collected and reported by NGINX Ingress Controller:
@@ -60,6 +69,8 @@ These are the data points collected and reported by NGINX Ingress Controller:
60
69
61
70
---
62
71
72
+
---
73
+
63
74
## Opt out
64
75
65
76
Product telemetry can be disabled when installing NGINX Ingress Controller.
Copy file name to clipboardExpand all lines: docs/content/technical-specifications.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,6 +72,8 @@ _NGINX Plus images include NGINX Plus R32._
72
72
73
73
---
74
74
75
+
---
76
+
75
77
#### **F5 Container registry**
76
78
77
79
NGINX Plus images are available through the F5 Container registry `private-registry.nginx.com`, explained in the [Get the NGINX Ingress Controller image with JWT]({{<relref "/installation/nic-images/using-the-jwt-token-docker-secret.md">}}) and [Get the F5 Registry NGINX Ingress Controller image]({{<relref "/installation/nic-images/pulling-ingress-controller-image.md">}}) topics.
Copy file name to clipboardExpand all lines: docs/content/usage-reporting.md
+110Lines changed: 110 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,16 @@ docs: DOCS-1445
3
3
doctypes:
4
4
- concept
5
5
title: Enable Usage Reporting
6
+
title: Enable Usage Reporting
6
7
toc: true
7
8
weight: 1800
8
9
---
9
10
10
11
This page describes how to enable Usage Reporting for F5 NGINX Ingress Controller and how to view usage data through the API.
11
12
13
+
---
14
+
This page describes how to enable Usage Reporting for F5 NGINX Ingress Controller and how to view usage data through the API.
15
+
12
16
---
13
17
14
18
## Overview
@@ -17,6 +21,9 @@ Usage Reporting is a Kubernetes controller that connects to the NGINX Management
17
21
18
22
To use Usage Reporting, you must have access to NGINX Management Suite. For more information, see [NGINX Management Suite](https://www.f5.com/products/nginx/instance-manager/). Usage Reporting is a requirement of the new Flexible Consumption Program for NGINX Ingress Controller.
19
23
24
+
---
25
+
To use Usage Reporting, you must have access to NGINX Management Suite. For more information, see [NGINX Management Suite](https://www.f5.com/products/nginx/instance-manager/). Usage Reporting is a requirement of the new Flexible Consumption Program for NGINX Ingress Controller.
26
+
20
27
---
21
28
22
29
## Requirements
@@ -36,6 +43,9 @@ In addition to the software requirements, you will need:
36
43
37
44
---
38
45
46
+
## Add a user account to NGINX Management Suite
47
+
---
48
+
39
49
## Add a user account to NGINX Management Suite
40
50
41
51
Usage Reporting needs a user account to send usage data to NGINX Instance Manager: these are the steps involved.
@@ -48,17 +58,29 @@ Usage Reporting needs a user account to send usage data to NGINX Instance Manage
48
58
1. Create a user account following the steps in [Add Users](https://docs.nginx.com/nginx-management-suite/admin-guides/access-control/set-up-rbac/#add-users) section of the NGINX Management Suite 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.
49
59
50
60
---
61
+
1. Create a user account following the steps in [Add Users](https://docs.nginx.com/nginx-management-suite/admin-guides/access-control/set-up-rbac/#add-users) section of the NGINX Management Suite 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.
51
62
63
+
---
64
+
65
+
## Deploy Usage Reporting
52
66
## Deploy Usage Reporting
53
67
68
+
### Create a namespace
54
69
### Create a namespace
55
70
71
+
Create the Kubernetes namespace `nginx-cluster-connector` for Usage Reporting:
56
72
Create the Kubernetes namespace `nginx-cluster-connector` for Usage Reporting:
57
73
58
74
```shell
59
75
kubectl create namespace nginx-cluster-connector
60
76
```
77
+
```shell
78
+
kubectl create namespace nginx-cluster-connector
79
+
```
80
+
81
+
---
61
82
83
+
### Pass the credential to the NGINX Management Suite API
62
84
---
63
85
64
86
### Pass the credential to the NGINX Management Suite API
@@ -67,17 +89,40 @@ To make the credential available to Usage Reporting, create a Kubernetes secret.
67
89
68
90
Both the username and password are stored in the Kubernetes Secret and need to be converted to base64. In this example the username will be `foo` and the password will be `bar`.
69
91
92
+
To obtain the base64 representation of a string, use the following command:
93
+
To make the credential available to Usage Reporting, create a Kubernetes secret. The username and password created in the previous section are required to connect the NGINX Management Suite API.
94
+
95
+
Both the username and password are stored in the Kubernetes Secret and need to be converted to base64. In this example the username will be `foo` and the password will be `bar`.
96
+
70
97
To obtain the base64 representation of a string, use the following command:
71
98
99
+
```shell
100
+
echo -n 'foo'| base64
101
+
# Zm9v
102
+
echo -n 'bar'| base64
103
+
# YmFy
104
+
```
72
105
```shell
73
106
echo -n 'foo'| base64
74
107
# Zm9v
75
108
echo -n 'bar'| base64
76
109
# YmFy
77
110
```
78
111
112
+
Add the following content to a text editor, and insert the base64 representations of the username and password (Obtained in the previous step) to the `data` parameter:
79
113
Add the following content to a text editor, and insert the base64 representations of the username and password (Obtained in the previous step) to the `data` parameter:
80
114
115
+
```yaml
116
+
apiVersion: v1
117
+
kind: Secret
118
+
metadata:
119
+
name: nms-basic-auth
120
+
namespace: nginx-cluster-connector
121
+
type: kubernetes.io/basic-auth
122
+
data:
123
+
username: Zm9v # base64 representation of 'foo'
124
+
password: YmFy # base64 representation of 'bar'
125
+
```
81
126
```yaml
82
127
apiVersion: v1
83
128
kind: Secret
@@ -99,7 +144,19 @@ If you are using a different namespace, change the namespace in the `metadata` s
99
144
---
100
145
101
146
### Deploy the Kubernetes secret to the Kubernetes cluster
147
+
Save this in a file named `nms-basic-auth.yaml`. In the example, the namespace is `nginx-cluster-connector` (The default namespace) and the secret name is `nms-basic-auth`.
102
148
149
+
If you are using a different namespace, change the namespace in the `metadata` section of the file above.
150
+
151
+
{{< note >}} Usage Reporting only supports basic-auth secret type in `data` format, not `stringData`, with the username and password encoded in base64. {{< /note >}}
152
+
153
+
---
154
+
155
+
### Deploy the Kubernetes secret to the Kubernetes cluster
156
+
157
+
```shell
158
+
kubectl apply -f nms-basic-auth.yaml
159
+
```
103
160
```shell
104
161
kubectl apply -f nms-basic-auth.yaml
105
162
```
@@ -108,6 +165,11 @@ If you need to update the basic-auth credentials for NGINX Management Suite in t
108
165
109
166
Download and save the deployment file [cluster-connector.yaml](https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v{{< nic-version >}}/examples/shared-examples/usage-reporting/cluster-connector.yaml). Edit the following under the `args` section and then save the file:
@@ -121,29 +183,45 @@ Download and save the deployment file [cluster-connector.yaml](https://raw.githu
121
183
122
184
It can be created with the command `oc create -f scc.yaml`, using the file found in `shared-examples/` {{< /note >}}
123
185
186
+
For more information, read the [Command-line arguments](#command-line-arguments) section of this page.
124
187
For more information, read the [Command-line arguments](#command-line-arguments) section of this page.
125
188
126
189
---
127
190
128
191
### Finish deployment
129
192
130
193
To deploy Usage Reporting, run the following command to deploy it to your Kubernetes cluster:
194
+
---
195
+
196
+
### Finish deployment
131
197
198
+
To deploy Usage Reporting, run the following command to deploy it to your Kubernetes cluster:
199
+
200
+
```shell
201
+
kubectl apply -f cluster-connector.yaml
202
+
```
132
203
```shell
133
204
kubectl apply -f cluster-connector.yaml
134
205
```
135
206
136
207
---
137
208
209
+
## Viewing usage data from the NGINX Management Suite API
210
+
---
211
+
138
212
## Viewing usage data from the NGINX Management Suite API
139
213
140
214
Usage Reporting sends the number of NGINX Ingress Controller instances and nodes in the cluster to NGINX Management Suite. To view the usage data, query the NGINX Management Suite API. The usage data is available at the following endpoint:
If you want a friendly name for each cluster in the response, You can specify the `displayName` for the cluster with the `-cluster-display-name` command-line argument when you deploy Usage Reporting. In the response, you can see the cluster `uid` corresponding to the cluster name. For more information, read the [Command-line Arguments](#command-line-arguments) section.
200
278
279
+
You can query the usage data for a specific cluster by specifying the cluster uid in the endpoint, for example:
201
280
You can query the usage data for a specific cluster by specifying the cluster uid in the endpoint, for example:
0 commit comments