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: CONTRIBUTING.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ To suggest a feature or enhancement, open an issue on GitHub with the label
30
30
`feature` or `enhancement` using the available feature request issue template.
31
31
Please ensure the feature or enhancement has not already been suggested.
32
32
33
-
## Open a discussion
33
+
## Open a Discussion
34
34
35
35
If you want to start a conversation with the community and maintainers,
36
36
we encourage you to use
@@ -48,7 +48,7 @@ To contribute to F5 NGINX documentation, follow these steps:
48
48
Alternatively, you're welcome to suggest improvements to highlight problems with
49
49
our documentation as described in our [support](./SUPPORT.md) page.
50
50
51
-
### Git Style Guide
51
+
### Git style guide
52
52
53
53
- Keep a clean, concise and meaningful Git commit history on your branch, rebasing locally and squashing before you submit a PR
54
54
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
@@ -61,6 +61,15 @@ our documentation as described in our [support](./SUPPORT.md) page.
61
61
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in
62
62
your text editor to write a good message instead of `git commit -am`)
63
63
64
+
#### Branch protection rules
65
+
66
+
This repository has the following branch protection rules in place:
67
+
68
+
-**Pushing branches that contain the "internal/" prefix is not allowed.** This ensures internal development branches are not accidentally or purposefully pushed to this repo.
69
+
-**Two approvers are required for all merges to main and release branches.** This ensures all code that is approved for release to production is appropriately reviewed. This rule applies to all branches with `*release*` in the branch name.
70
+
-**Only NGINX DocOps Team members can create release branches.** This ensures the docs team is aware of all branches supporting specific product releases. This rule applies to all branches with `*release*` in the branch name.
71
+
-**Pushes (force or otherwise) directly to main or release branches is not allowed.** Release branches serve as "main" for the release they are associated with. Restricting pushes directly to main and release branches ensures all content changes are reviewed and approved. This rule applies to all branches with `*release*` in the branch name and to "main".
72
+
64
73
### Documentation style guide
65
74
66
75
For detailed guidance, see our documentation [style guide](./templates/style-guide.md).
Copy file name to clipboardExpand all lines: content/amplify/nginx-amplify-agent/install/installing-amplify-agent.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ docs: "DOCS-968"
9
9
10
10
To use F5 NGINX Amplify to monitor your infrastructure, you need to install NGINX Amplify Agent on each system you wish to monitor.
11
11
12
-
{{< note >}} NGINX Amplify Agent will drop *root* privileges on startup. It will then use the user ID of the user `nginx` to set its effective user ID. The package install procedure will add the `nginx` user automatically unless it's already found in the system. If the [user](http://nginx.org/en/docs/ngx_core_module.html#user) directive appears in the NGINX configuration, NGINX Amplify Agent will pick up the user specified in the NGINX config for its effective user ID (e.g. `www-data`). {{< /note >}}
12
+
{{< note >}} NGINX Amplify Agent will drop *root* privileges on startup. It will then use the user ID of the user `nginx` to set its effective user ID. The package install procedure will add the `nginx` user automatically unless it's already found in the system. If the [user](https://nginx.org/en/docs/ngx_core_module.html#user) directive appears in the NGINX configuration, NGINX Amplify Agent will pick up the user specified in the NGINX config for its effective user ID (e.g. `www-data`). {{< /note >}}
13
13
14
14
## Using the Install Script
15
15
@@ -39,30 +39,30 @@ Take the following steps to install NGINX Amplify Agent:
Copy file name to clipboardExpand all lines: content/nap-waf/v4/logging-overview/security-log.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -274,7 +274,6 @@ The table below lists attributes that are generated in the security logs. When u
274
274
| enforced_bot_anomalies | Comma-separated list of anomalies that caused the request to be blocked. | default, grpc |
275
275
| grpc_method | The method name of the gRPC request (derived from the URI). Not to be confused with `http_method`. Applicable only to requests that are processed by a gRPC Content Profile. The value is `N/A` in other cases. | grpc |
276
276
| grpc_service | The service name of the gRPC request (derived from the URI). Applicable only to requests that are processed by a gRPC Content Profile. The value is `N/A` in other cases. | grpc |
277
-
| grpc_message | The value of the `grpc-message` header | grpc |
278
277
| compression_method | The compression algorithm used for the present message. Currently one of: <ul><li>gzip</li><li>deflate</li><li>none</li><li>n/a</li></ul> | grpc |
279
278
|headers | The headers part of the request including the query string but not the body. | grpc |
280
279
|ip_client | The source IP of the client initiating the request<br> Note: if a proxy is being used, this may differ from the IP in the `X-Forwarded-For` header. | default, grpc |
Copy file name to clipboardExpand all lines: content/nap-waf/v5/logging-overview/security-log.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -256,7 +256,6 @@ The table below lists attributes that are generated in the security logs. When u
256
256
| enforced_bot_anomalies | Comma-separated list of anomalies that caused the request to be blocked. | default, grpc |
257
257
| grpc_method | The method name of the gRPC request (derived from the URI). Not to be confused with 'http_method`. Applicable only to requests that are processed by a gRPC Content Profile. The value is `N/A` in other cases. | grpc |
258
258
| grpc_service | The service name of the gRPC request (derived from the URI). Applicable only to requests that are processed by a gRPC Content Profile. The value is `N/A` in other cases. | grpc |
259
-
| grpc_message | The value of the `grpc-message` header | grpc |
260
259
| compression_method | The compression algorithm used for the present message. Currently one of: <ul><li>gzip</li><li>deflate</li><li>none</li><li>n/a</li></ul> | grpc |
261
260
|headers | The headers part of the request including the query string but not the body. | grpc |
262
261
|ip_client | The source IP of the client initiating the request<br> Note: if a proxy is being used, this may differ from the IP in the `X-Forwarded-For` header. | default, grpc |
Copy file name to clipboardExpand all lines: content/nginx-one/getting-started.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,6 +51,14 @@ Data plane keys expire after one year. You can change this expiration date later
51
51
52
52
After entering your data plane key, you'll see a `curl` command similar to the one below. Copy and run this command on each NGINX instance to install the NGINX Agent. Once installed, the NGINX Agent typically registers with NGINX One within a few seconds.
53
53
54
+
{{<call-out "important" "Connecting to NGINX One" >}}
55
+
The NGINX Agent must be able to establish a connection to the NGINX One Console's Agent endpoint (`agent.connect.nginx.com`). Ensure that any firewall rules you have in place for your NGINX hosts allows network traffic to port `443` for all of the following IPs:
56
+
57
+
-`3.135.72.139`
58
+
-`3.133.232.50`
59
+
-`52.14.85.249`
60
+
{{</call-out>}}
61
+
54
62
To install the NGINX Agent on an NGINX instance:
55
63
56
64
1.**Check if NGINX is running and start it if it's not:**
Copy file name to clipboardExpand all lines: content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,11 +60,11 @@ If you need to deactivate a data plane key before its expiration date, follow th
60
60
4. A confirmation dialog will appear. Select **Revoke** to confirm.
61
61
62
62
63
-
## Delete a data plane key (API only)
63
+
## Delete a data plane key
64
64
65
-
In this release, you need to use the NGINX One REST API to delete a data plane key. However, before you can delete a key, it must be revoked. You can revoke a key either through the NGINX One console, as explained above, or by using the REST API.
65
+
Before you can delete a key, it must be expired or revoked. You can revoke a key either through the NGINX One console, as explained above, or by using the REST API. Once deleted, all information about the data plane key is permanently removed.
66
66
67
-
To delete a data plane key using the NGINX One REST API, see these guides:
68
-
69
-
-[Authenticate with the NGINX One REST API]({{< relref "nginx-one/api/authentication.md" >}})
70
-
-[Delete a data plane key: NGINX One API Reference]({{< relref "nginx-one/api/api-reference-guide.md#operation/deleteDataPlaneKey" >}})
67
+
1. On the left menu, select **Data Plane Keys**.
68
+
2. Find the key you want to revoke in the list of expired or revoked keys.
69
+
3. Next to the key name, select the check box. You can select multiple keys at the same time.
Copy file name to clipboardExpand all lines: content/nginx-one/how-to/nginx-configs/add-instance.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,13 +37,15 @@ In either case, NGINX One Console gives you a choice for data plane keys:
37
37
- Create a new key
38
38
- Use an existing key
39
39
40
-
NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the call in the **Add Instance** screen in the console. The command looks like:
40
+
NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console.
41
+
42
+
Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< relref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host.
41
43
42
44
```bash
43
-
curl https://<tenant URL>/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
45
+
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
44
46
```
45
47
46
-
Sign in to the instance that you want to add. Run that command. If needed, the script [installs NGINX Agent]({{< relref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages. Once the process is complete, you can configure that instance in your NGINX One Console.
48
+
Once the process is complete, you can configure that instance in your NGINX One Console.
0 commit comments