Skip to content

Commit c7ce27c

Browse files
committed
Draft: new N1C doc homepage
1 parent 507005d commit c7ce27c

35 files changed

+1855
-534
lines changed
Lines changed: 41 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,74 @@
1-
---
2-
docs: DOCS-1031
3-
files:
4-
- content/nim/nginx-app-protect/setup-waf-config-management.md
5-
---
6-
7-
{{<note>}}Make sure `gpg` is installed on your system before continuing. You can install NGINX Agent using command-line tools like `curl` or `wget`.{{</note>}}
8-
9-
If your NGINX Instance Manager host doesn't use valid TLS certificates, you can use the insecure flags to bypass verification. Here are some example commands:
1+
**Note**: To complete this step, make sure that `gpg` is installed on your system. You can install NGINX Agent using various command-line tools like `curl` or `wget`. If your NGINX Instance Manager host is not set up with valid TLS certificates, you can use the insecure flags provided by those tools. See the following examples:
102

113
{{<tabs name="install-agent-api">}}
124

135
{{%tab name="curl"%}}
146

15-
- **Secure:**
7+
- Secure:
168

179
```bash
18-
curl https://<NIM_FQDN>/install/nginx-agent | sudo sh
10+
curl https://<NMS_FQDN>/install/nginx-agent | sudo sh
1911
```
2012

21-
- **Insecure:**
13+
- Insecure:
2214

2315
```bash
24-
curl --insecure https://<NIM_FQDN>/install/nginx-agent | sudo sh
16+
curl --insecure https://<NMS_FQDN>/install/nginx-agent | sudo sh
2517
```
2618

27-
To add the instance to a specific instance group during installation, use the `--instance-group` (or `-g`) flag:
19+
You can add your NGINX instance to an existing instance group or create one using `--instance-group` or `-g` flag when installing NGINX Agent.
20+
21+
The following example shows how to download and run the script with the optional `--instance-group` flag adding the NGINX instance to the instance group **my-instance-group**:
22+
23+
```bash
24+
curl https://<NMS_FQDN>/install/nginx-agent > install.sh; chmod u+x install.sh
25+
sudo ./install.sh --instance-group my-instance-group
26+
```
2827

29-
```shell
30-
curl https://<NIM_FQDN>/install/nginx-agent -o install.sh
31-
chmod u+x install.sh
32-
sudo ./install.sh --instance-group <instance group>
33-
```
28+
By default, the install script attempts to use a secure connection when downloading packages. If, however, the script cannot create a secure connection, it uses an insecure connection instead and logs the following warning message:
3429

35-
By default, the install script uses a secure connection to download packages. If it can’t establish one, it falls back to an insecure connection and logs this message:
30+
``` text
31+
Warning: An insecure connection will be used during this nginx-agent installation
32+
```
3633

37-
```text
38-
Warning: An insecure connection will be used during this nginx-agent installation
39-
```
34+
To require a secure connection, you can set the optional flag `skip-verify` to `false`.
4035

41-
To enforce a secure connection, set the `--skip-verify` flag to false:
36+
The following example shows how to download and run the script with an enforced secure connection:
4237

43-
```shell
44-
curl https://<NIM_FQDN>/install/nginx-agent -o install.sh
45-
chmod u+x install.sh
46-
sudo ./install.sh --skip-verify false
47-
```
38+
```bash
39+
curl https://<NMS_FQDN>/install/nginx-agent > install.sh chmod u+x install.sh; chmod u+x install.sh
40+
sudo sh ./install.sh --skip-verify false
41+
```
4842

4943
{{%/tab%}}
5044

5145
{{%tab name="wget"%}}
5246

53-
- **Secure:**
5447

55-
```shell
56-
wget https://<NIM_FQDN>/install/nginx-agent -O - | sudo sh -s --skip-verify false
48+
- Secure:
49+
50+
```bash
51+
wget https://<NMS_FQDN>/install/nginx-agent -O - | sudo sh -s --skip-verify false
5752
```
5853

59-
- **Insecure:**
54+
- Insecure:
6055

61-
```shell
62-
wget --no-check-certificate https://<NIM_FQDN>/install/nginx-agent -O - | sudo sh
56+
```bash
57+
wget --no-check-certificate https://<NMS_FQDN>/install/nginx-agent -O - | sudo sh
6358
```
6459

65-
To add your instance to a group during installation, use the `--instance-group` (or `-g`) flag:
60+
When you install the NGINX Agent, you can use the `--instance-group` or `-g` flag to add your NGINX instance to an existing instance group or to a new group that you specify.
6661

67-
```shell
68-
wget https://<NIM_FQDN>/install/nginx-agent -O install.sh
69-
chmod u+x install.sh
70-
sudo ./install.sh --instance-group <instance group>
71-
```
62+
The following example downloads and runs the NGINX Agent install script with the optional `--instance-group` flag, adding the NGINX instance to the instance group **my-instance-group**:
63+
64+
```bash
65+
wget https://gnms1.npi.f5net.com/install/nginx-agent -O install.sh ; chmod u+x install.sh
66+
sudo ./install.sh --instance-group my-instance-group
67+
```
7268

73-
{{%/tab%}}
7469

70+
{{%/tab%}}
7571
{{</tabs>}}
72+
73+
<!-- Do not remove. Keep this code at the bottom of the include -->
74+
<!-- DOCS-1031 -->

content/includes/nap-waf/build-nginx-image-cmd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To build the image, execute the following command in the directory containing th
1010

1111

1212
```shell
13-
sudo docker build --no-cache --platform linux/amd64 \
13+
sudo docker build --no-cache \
1414
--secret id=nginx-crt,src=nginx-repo.crt \
1515
--secret id=nginx-key,src=nginx-repo.key \
1616
-t nginx-app-protect-5 .

content/includes/nginx-one/add-file/existing-ssl-bundle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs:
33
---
44

5-
With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
5+
With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
66
In the **Choose Certificate** drop-down, select the managed certificate of your choice, and select **Add**. You can then:
77

88
1. Review details of the certificate. The next steps depend on whether the certificate is a CA bundle or a certificate / key pair.

content/nap-dos/deployment-guide/learn-about-deployment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1405,7 +1405,7 @@ You need root permissions to execute the following steps.
14051405
6. Create a Docker image:
14061406
14071407
```shell
1408-
docker build --no-cache --platform linux/amd64 -t app-protect-dos .
1408+
docker build --no-cache -t app-protect-dos .
14091409
```
14101410
14111411
The `--no-cache` option tells Docker to build the image from scratch and ensures the installation of the latest version of NGINX Plus and NGINX App Protect DoS. If the Dockerfile was previously used to build an image without the `--no-cache` option, the new image uses versions from the previously built image from the Docker cache.
@@ -1966,13 +1966,13 @@ Make sure to replace upstream and proxy pass directives in this example with rel
19661966
For CentOS:
19671967
19681968
```shell
1969-
docker build --no-cache --platform linux/amd64 -t app-protect-dos .
1969+
docker build --no-cache -t app-protect-dos .
19701970
```
19711971
19721972
For RHEL:
19731973
19741974
```shell
1975-
docker build --platform linux/amd64 --build-arg RHEL_ORGANIZATION=${RHEL_ORGANIZATION} --build-arg RHEL_ACTIVATION_KEY=${RHEL_ACTIVATION_KEY} --no-cache -t app-protect-dos .
1975+
docker build --build-arg RHEL_ORGANIZATION=${RHEL_ORGANIZATION} --build-arg RHEL_ACTIVATION_KEY=${RHEL_ACTIVATION_KEY} --no-cache -t app-protect-dos .
19761976
```
19771977
19781978
The `--no-cache` option tells Docker to build the image from scratch and ensures the installation of the latest version of NGINX Plus and NGINX App Protect DoS. If the Dockerfile was previously used to build an image without the `--no-cache` option, the new image uses versions from the previously built image from the Docker cache.

content/nap-waf/v4/admin-guide/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -939,7 +939,7 @@ If a user other than **nginx** is to be used, note the following:
939939
- For Oracle Linux/Debian/Ubuntu/Alpine/Amazon Linux:
940940
941941
```shell
942-
DOCKER_BUILDKIT=1 docker build --no-cache --platform linux/amd64 --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key -t app-protect .
942+
DOCKER_BUILDKIT=1 docker build --no-cache --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key -t app-protect .
943943
```
944944
945945
The `DOCKER_BUILDKIT=1` enables `docker build` to recognize the `--secret` flag which allows the user to pass secret information to be used in the Dockerfile for building docker images in a safe way that will not end up stored in the final image. This is a recommended practice for the handling of the certificate and private key for NGINX repository access (`nginx-repo.crt` and `nginx-repo.key` files). More information [here](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret).
@@ -1289,7 +1289,7 @@ You need root permissions to execute the following steps.
12891289
- For Oracle Linux/Debian/Ubuntu/Alpine/Amazon Linux:
12901290
12911291
```shell
1292-
DOCKER_BUILDKIT=1 docker build --no-cache --platform linux/amd64 --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key -t app-protect-converter .
1292+
DOCKER_BUILDKIT=1 docker build --no-cache --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-key,src=nginx-repo.key -t app-protect-converter .
12931293
```
12941294
12951295
The `DOCKER_BUILDKIT=1` enables `docker build` to recognize the `--secret` flag which allows the user to pass secret information to be used in the Dockerfile for building docker images in a safe way that will not end up stored in the final image. This is a recommended practice for the handling of the certificate and private key for NGINX repository access (`nginx-repo.crt` and `nginx-repo.key` files). More information [here](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret).

content/nap-waf/v5/admin-guide/compiler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ curl -s https://private-registry.nginx.com/v2/nap/waf-compiler/tags/list --key <
9898
Run the command below to build your image, where `waf-compiler-<version-tag>:custom` is an example of the image tag:
9999

100100
```shell
101-
sudo docker build --no-cache --platform linux/amd64 \
101+
sudo docker build --no-cache \
102102
--secret id=nginx-crt,src=nginx-repo.crt \
103103
--secret id=nginx-key,src=nginx-repo.key \
104104
-t waf-compiler-<version-tag>:custom .

content/ngf/overview/custom-policies.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,10 @@ The following table summarizes NGINX Gateway Fabric custom policies:
1717

1818
{{< bootstrap-table "table table-striped table-bordered" >}}
1919

20-
| Policy | Description | Attachment Type | Supported Target Object(s) | Supports Multiple Target Refs | Mergeable | API Version |
21-
|---------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------|-------------------------------|-----------|-------------|
22-
| [ClientSettingsPolicy]({{< ref "/ngf/how-to/traffic-management/client-settings.md" >}}) | Configure connection behavior between client and NGINX | Inherited | Gateway, HTTPRoute, GRPCRoute | No | Yes | v1alpha1 |
23-
| [ObservabilityPolicy]({{< ref "/ngf/how-to/monitoring/tracing.md" >}}) | Define settings related to tracing, metrics, or logging | Direct | HTTPRoute, GRPCRoute | Yes | No | v1alpha2 |
24-
| [UpstreamSettingsPolicy]({{< ref "/ngf/how-to/traffic-management/upstream-settings.md" >}}) | Configure connection behavior between NGINX and backend | Direct | Service | Yes | Yes | v1alpha1 |
20+
| Policy | Description | Attachment Type | Supported Target Object(s) | Supports Multiple Target Refs | Mergeable | API Version |
21+
|---------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------|-------------------------------|-----------|-------------|
22+
| [ClientSettingsPolicy]({{< ref "/ngf/how-to/traffic-management/client-settings.md" >}}) | Configure connection behavior between client and NGINX | Inherited | Gateway, HTTPRoute, GRPCRoute | No | Yes | v1alpha1 |
23+
| [ObservabilityPolicy]({{< ref "/ngf/how-to/monitoring/tracing.md" >}}) | Define settings related to tracing, metrics, or logging | Direct | HTTPRoute, GRPCRoute | Yes | No | v1alpha1 |
2524

2625
{{< /bootstrap-table >}}
2726

content/ngf/overview/product-telemetry.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ Telemetry data is collected once every 24 hours and sent to a service managed by
3232
- **Image Build Source:** whether the image was built by GitHub or locally (values are `gha`, `local`, or `unknown`). The source repository of the images is **not** collected.
3333
- **Deployment Flags:** a list of NGINX Gateway Fabric Deployment flags that are specified by a user. The actual values of non-boolean flags are **not** collected; we only record that they are either `true` or `false` for boolean flags and `default` or `user-defined` for the rest.
3434
- **Count of Resources:** the total count of resources related to NGINX Gateway Fabric. This includes `GatewayClasses`, `Gateways`, `HTTPRoutes`,`GRPCRoutes`, `TLSRoutes`, `Secrets`, `Services`, `BackendTLSPolicies`, `ClientSettingsPolicies`, `NginxProxies`, `ObservabilityPolicies`, `UpstreamSettingsPolicies`, `SnippetsFilters`, and `Endpoints`. The data within these resources is **not** collected.
35-
- **SnippetsFilters Info:** a list of directive-context strings from applied SnippetFilters and a total count per strings. The actual value of any NGINX directive is **not** collected.
36-
35+
- **SnippetsFilters Info**a list of directive-context strings from applied SnippetFilters and a total count per strings. The actual value of any NGINX directive is **not** collected.
3736
This data is used to identify the following information:
3837

3938
- The flavors of Kubernetes environments that are most popular among our users.

content/nginx-one/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: ''
33
docs: DOCS-1392
4-
title: About
4+
title: Manage your NGINX fleet
55
toc: true
66
weight: 10
77
type:

content/nginx-one/api/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: API
2+
title: NGINX One API
33
description:
44
weight: 1000
55
url: /nginx-one/api
6-
---
6+
---
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description:
3+
title: Monitor your certificates
4+
weight: 400
5+
url: /nginx-one/certificates
6+
---

0 commit comments

Comments
 (0)