Skip to content

Commit 7ce1277

Browse files
authored
Merge branch 'main' into update-pr-template
2 parents 5463682 + 540ee26 commit 7ce1277

File tree

9 files changed

+45
-28
lines changed

9 files changed

+45
-28
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To suggest a feature or enhancement, open an issue on GitHub with the label
3030
`feature` or `enhancement` using the available feature request issue template.
3131
Please ensure the feature or enhancement has not already been suggested.
3232

33-
## Open a discussion
33+
## Open a Discussion
3434

3535
If you want to start a conversation with the community and maintainers,
3636
we encourage you to use
@@ -48,7 +48,7 @@ To contribute to F5 NGINX documentation, follow these steps:
4848
Alternatively, you're welcome to suggest improvements to highlight problems with
4949
our documentation as described in our [support](./SUPPORT.md) page.
5050

51-
### Git Style Guide
51+
### Git style guide
5252

5353
- Keep a clean, concise and meaningful Git commit history on your branch, rebasing locally and squashing before you submit a PR
5454
- 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.
6161
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in
6262
your text editor to write a good message instead of `git commit -am`)
6363

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+
6473
### Documentation style guide
6574

6675
For detailed guidance, see our documentation [style guide](./templates/style-guide.md).

CONTRIBUTING_DOCS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Here are some other shortcodes:
146146
- `tab`: Create mutually exclusive tabbed window panes, useful for parallel instructions
147147
- `table`: Add scrollbars to wide tables for browsers with smaller viewports
148148
- `link`: Link to a file, prepending its path with the Hugo baseUrl
149-
- `openapi`: Loads an OpenAPI specifcation and render it as HTML using ReDoc
149+
- `openapi`: Loads an OpenAPI specification and render it as HTML using ReDoc
150150
- `include`: Include the content of a file in another file; the included file must be present in the '/content/includes/' directory
151151
- `raw-html`: Include a block of raw HTML
152152
- `readfile`: Include the content of another file in the current file, which can be in an arbitrary location.

content/amplify/faq/nginx-amplify-agent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ The F5 NGINX Amplify Agent is currently officially packaged and supported for th
1313

1414
* Ubuntu 22.04 "jammy" (amd64/arm64)
1515
* Ubuntu 20.04 "focal" (amd64/arm64)
16-
* Ubuntu 18.04 "bionic" (amd64/arm64)
1716
* Debian 12 "bookworm" (amd64/arm64)
1817
* Debian 11 "bullseye" (amd64/arm64)
19-
* Debian 10 "buster" (amd64/arm64)
2018
* RHEL/CentOS/OEL 9 (amd64/arm64)
2119
* Amazon Linux 2 LTS (amd64/arm64)
2220

2321
The following platforms are no longer supported but still can be used with older agent packages powered by Python 3:
2422

2523
* RHEL/CentOS/OEL 8 (amd64/arm64)
24+
* Ubuntu 18.04 "bionic" (amd64/arm64)
25+
* Debian 10 "buster" (amd64/arm64)
2626

2727
The following platforms are no longer supported but still can be used with older agent packages powered by Python 2:
2828

content/amplify/nginx-amplify-agent/install/installing-amplify-agent.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ docs: "DOCS-968"
99

1010
To use F5 NGINX Amplify to monitor your infrastructure, you need to install NGINX Amplify Agent on each system you wish to monitor.
1111

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 >}}
1313

1414
## Using the Install Script
1515

@@ -39,30 +39,30 @@ Take the following steps to install NGINX Amplify Agent:
3939
1. Add the NGINX public key.
4040

4141
```bash
42-
curl -fs http://nginx.org/keys/nginx_signing.key | apt-key add -
42+
curl -fs https://nginx.org/keys/nginx_signing.key | apt-key add -
4343
```
4444

4545
or
4646

4747
```bash
4848
wget -q -O - \
49-
http://nginx.org/keys/nginx_signing.key | apt-key add -
49+
https://nginx.org/keys/nginx_signing.key | apt-key add -
5050
```
5151

5252
2. Configure the repository as follows.
5353

5454
```bash
5555
codename=`lsb_release -cs` && \
5656
os=`lsb_release -is | tr '[:upper:]' '[:lower:]'` && \
57-
echo "deb http://packages.amplify.nginx.com/${os}/ ${codename} amplify-agent" > \
57+
echo "deb https://packages.amplify.nginx.com/py3/${os} ${codename} amplify-agent" > \
5858
/etc/apt/sources.list.d/nginx-amplify.list
5959
```
6060

61-
3. Verify the repository config file (Ubuntu 14.04 example follows).
61+
3. Verify the repository config file (Ubuntu 22.04 example follows).
6262

6363
```bash
6464
cat /etc/apt/sources.list.d/nginx-amplify.list
65-
deb http://packages.amplify.nginx.com/ubuntu/ trusty amplify-agent
65+
deb https://packages.amplify.nginx.com/py3/ubuntu jammy amplify-agent
6666
```
6767

6868
4. Update the package index files.
@@ -82,14 +82,14 @@ Take the following steps to install NGINX Amplify Agent:
8282
1. Add the NGINX public key.
8383

8484
```bash
85-
curl -sS -L -O http://nginx.org/keys/nginx_signing.key && \
85+
curl -sS -L -O https://nginx.org/keys/nginx_signing.key && \
8686
rpm --import nginx_signing.key
8787
```
8888

8989
or
9090

9191
```bash
92-
wget -q -O nginx_signing.key http://nginx.org/keys/nginx_signing.key && \
92+
wget -q -O nginx_signing.key https://nginx.org/keys/nginx_signing.key && \
9393
rpm --import nginx_signing.key
9494
```
9595

@@ -99,23 +99,23 @@ Take the following steps to install NGINX Amplify Agent:
9999

100100
```bash
101101
release="7" && \
102-
printf "[nginx-amplify]\nname=nginx amplify repo\nbaseurl=http://packages.amplify.nginx.com/centos/${release}/\$basearch\ngpgcheck=1\nenabled=1\n" > \
102+
printf "[nginx-amplify]\nname=nginx amplify repo\nbaseurl=https://packages.amplify.nginx.com/py3/centos/${release}/\$basearch\ngpgcheck=1\nenabled=1\n" > \
103103
/etc/yum.repos.d/nginx-amplify.repo
104104
```
105105

106106
```bash
107107
release="latest" && \
108-
printf "[nginx-amplify]\nname=nginx amplify repo\nbaseurl=http://packages.amplify.nginx.com/amzn/${release}/\$basearch\ngpgcheck=1\nenabled=1\n" > \
108+
printf "[nginx-amplify]\nname=nginx amplify repo\nbaseurl=https://packages.amplify.nginx.com/py3/amzn/${release}/\$basearch\ngpgcheck=1\nenabled=1\n" > \
109109
/etc/yum.repos.d/nginx-amplify.repo
110110
```
111111

112-
3. Verify the repository config file (RHEL 7.1 example follows).
112+
3. Verify the repository config file (RHEL 9.5 example follows).
113113

114114
```bash
115115
cat /etc/yum.repos.d/nginx-amplify.repo
116116
[nginx-amplify]
117117
name=nginx repo
118-
baseurl=http://packages.amplify.nginx.com/centos/7/$basearch
118+
baseurl=https://packages.amplify.nginx.com/centos/9/$basearch
119119
gpgcheck=1
120120
enabled=1
121121
```

content/nap-waf/v4/logging-overview/security-log.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,6 @@ The table below lists attributes that are generated in the security logs. When u
274274
| enforced_bot_anomalies | Comma-separated list of anomalies that caused the request to be blocked. | default, grpc |
275275
| 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 |
276276
| 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 |
278277
| 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 |
279278
|headers | The headers part of the request including the query string but not the body. | grpc |
280279
|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 |

content/nap-waf/v5/logging-overview/security-log.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,6 @@ The table below lists attributes that are generated in the security logs. When u
256256
| enforced_bot_anomalies | Comma-separated list of anomalies that caused the request to be blocked. | default, grpc |
257257
| 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 |
258258
| 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 |
260259
| 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 |
261260
|headers | The headers part of the request including the query string but not the body. | grpc |
262261
|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 |

content/nginx-one/getting-started.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ Data plane keys expire after one year. You can change this expiration date later
5151

5252
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.
5353

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+
5462
To install the NGINX Agent on an NGINX instance:
5563

5664
1. **Check if NGINX is running and start it if it's not:**

content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ If you need to deactivate a data plane key before its expiration date, follow th
6060
4. A confirmation dialog will appear. Select **Revoke** to confirm.
6161

6262

63-
## Delete a data plane key (API only)
63+
## Delete a data plane key
6464

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.
6666

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.
70+
4. Select **Delete selected**.

content/nginx-one/how-to/nginx-configs/add-instance.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,15 @@ In either case, NGINX One Console gives you a choice for data plane keys:
3737
- Create a new key
3838
- Use an existing key
3939

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.
4143

4244
```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
4446
```
4547

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.
4749

4850
## Managed and Unmanaged Certificates
4951

0 commit comments

Comments
 (0)