Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions archetypes/landing-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,16 @@ nd-product:
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."

{{<card-layout>}}
{{<card-section showAsCards="true" isFeaturedSection="true">}}
{{<card title="<some-title>">}}
<!-- Each description should be roughly 10 words or less. -->
{{</card>}}
<!-- The titleURL and icon are both optional -->
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
{{<card title="<some-title>" titleUrl="<some-url>" icon="<some-lucide-icon>">}}
<!-- Each description should be roughly 10 words or less. -->
{{</card>}}
{{</card-section>}}
{{</card-layout>}}
{{<card-section showAsCards="true" isFeaturedSection="true">}}
{{<card title="<some-title>">}}
<!-- Each description should be roughly 10 words or less. -->
{{</card>}}
<!-- The titleURL and icon are both optional -->
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
{{<card title="<some-title>" titleUrl="<some-url>" icon="<some-lucide-icon>">}}
<!-- Each description should be roughly 10 words or less. -->
{{</card>}}
{{</card-section>}}

## Other content

Expand Down
45 changes: 45 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,48 @@
title: NGINX Product Documentation
description: Learn how to deliver, manage, and protect your applications using F5 NGINX products.
---

## NGINX Product Documentation
Learn how to deliver, manage, and protect your applications using F5 NGINX products.

{{<card-section showAsCards="true" title="NGINX One">}}
{{<card title="NGINX One Console" titleUrl="/nginx-one/" brandIcon="NGINX-One-product-icon.svg" isLanding="true">}}
Monitor your infrastructure, address security vulnerabilities, and assess the health of your NGINX fleet, all from a single console.
{{</card >}}
{{<card title="NGINX Plus" titleUrl="/nginx/" brandIcon="NGINX-Plus-product-icon.svg" isLanding="true">}}
The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.
{{</card >}}
{{<card title="NGINX Instance Manager" titleUrl="/nginx-instance-manager/" brandIcon="NGINX-Instance-Manager-product-icon.svg" isLanding="true">}}
Track and control NGINX Open Source and NGINX Plus instances.
{{</card >}}
{{<card title="NGINX Ingress Controller" titleUrl="/nginx-ingress-controller/" brandIcon="NGINX-Ingress-Controller-product-icon.svg" isLanding="true">}}
Kubernetes traffic management with API gateway, identity, and observability features.
{{</card >}}
{{<card title="NGINX Gateway Fabric" titleUrl="/nginx-gateway-fabric/" brandIcon="NGINX-Gateway-Fabric-product-icon.svg" isLanding="true">}}
Next generation Kubernetes connectivity using the Gateway API.
{{</card >}}
{{<card title="NGINX Open Source" titleUrl="https://nginx.org/en/docs/" brandIcon="NGINX-Open-Source-product-icon.svg" isLanding="true">}}
The open source all-in-one load balancer, content cache, and web server
{{</card >}}
{{<card title="NGINX Agent" titleUrl="/nginx-agent/" brandIcon="NGINX-Agent-product-icon.svg" isLanding="true">}}
A daemon providing observability data and remote configuration for NGINX Open Source and NGINX Plus instances
{{</card >}}
{{<card title="Subscription Licensing & Solutions" titleUrl="/solutions/" brandIcon="NGINX-product-icon.svg" isLanding="true">}}
Stay compliant with your NGINX subscription licenses and see how you can use NGINX One to build secure, scalable, and high-performing applications and APIs.
{{</card >}}
{{</card-section>}}

{{<card-section showAsCards="true" title="NGINX App Protect">}}
{{<card title="NGINX App Protect WAF" titleUrl="/nginx-app-protect-waf/" brandIcon="NGINX-App-Protect-WAF-product-icon.svg" isLanding="true">}}
Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs
{{</card >}}
{{<card title="NGINX App Protect DoS" titleUrl="/nginx-app-protect-dos/" brandIcon="NGINX-App-Protect-DoS-product-icon.svg" isLanding="true">}}
Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs
{{</card >}}
{{</card-section>}}

{{<card-section showAsCards="true" title="NGINX as a Service">}}
{{<card title="NGINX as a Service for Azure" titleUrl="/nginxaas/azure/" brandIcon="NGINX-for-Azure-product-icon.svg" isLanding="true">}}
Infrastructure-as-a-Service (IaaS) version of NGINX Plus for your Microsoft Azure application stack
{{</card >}}
{{</card-section>}}
40 changes: 18 additions & 22 deletions content/agent/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,22 @@ configurations, collection and reporting of real-time NGINX performance and oper
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."

{{<card-layout>}}
{{<card-section showAsCards="true" isFeaturedSection="true">}}
{{<card title="About" titleUrl="/nginx-agent/about" icon="info">}}
Learn everything you need to know about NGINX Agent
{{</card>}}
<!-- The titleURL and icon are both optional -->
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
{{<card title="Getting started" titleUrl="/nginx-agent/installation-upgrade/getting-started" icon="unplug">}}
Install NGINX Agent and run a mock control plane
{{</card>}}
{{</card-section>}}
{{</card-layout>}}
{{<card-section showAsCards="true" isFeaturedSection="true">}}
{{<card title="About" titleUrl="about/" icon="info">}}
Learn everything you need to know about NGINX Agent
{{</card>}}
<!-- The titleURL and icon are both optional -->
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
{{<card title="Getting started" titleUrl="installation-upgrade/getting-started/" icon="unplug">}}
Install NGINX Agent and run a mock control plane
{{</card>}}
{{</card-section>}}

{{<card-layout>}}
{{<card-section showAsCards="true" isFeaturedSection="true">}}
{{<card title="Upgrade" titleUrl="/nginx-agent/installation-upgrade/upgrade/" icon="circle-fading-arrow-up">}}
{{</card>}}
{{<card title="Configuration" titleUrl="/nginx-agent/configuration" icon="cog">}}
{{</card>}}
{{<card title="Support" titleUrl="/nginx-agent/support" icon="hand-helping">}}
{{</card>}}
{{</card-section>}}
{{</card-layout>}}
{{<card-section showAsCards="true" isFeaturedSection="true">}}
{{<card title="Upgrade" titleUrl="installation-upgrade/upgrade/" icon="circle-fading-arrow-up">}}
{{</card>}}
{{<card title="Configuration" titleUrl="configuration/" icon="cog">}}
{{</card>}}
{{<card title="Support" titleUrl="support/" icon="hand-helping">}}
{{</card>}}
{{</card-section>}}
2 changes: 0 additions & 2 deletions content/agent/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ For NGINX Agent to work properly with an NGINX Plus instance, the API needs to b
NGINX Agent allows a gRPC connected control system to register a listener for a specific event. The control mechanism is then invoked when NGINX Agent sends an associated system signal. The source of a notification can be either the NGINX instance or NGINX Agent itself. Here's a list of currently supported events:


{{<bootstrap-table "table table-striped table-bordered">}}
| Event | Description |
| -------------------------------- | -------------------------------------------- |
| AGENT_START_MESSAGE | Agent process started |
Expand All @@ -61,7 +60,6 @@ NGINX Agent allows a gRPC connected control system to register a listener for a
| CONFIG_APPLY_FAILURE_MESSAGE | Failed to apply new NGINX configuration |
| CONFIG_ROLLBACK_SUCCESS_MESSAGE | Successfully rolled back NGINX configuration |
| CONFIG_ROLLBACK_FAILURE_MESSAGE | Failed to roll back NGINX configuration |
{{</bootstrap-table>}}



6 changes: 2 additions & 4 deletions content/agent/configuration/configuration-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ If you are upgrading from an older version, update your configuration accordingl

{{< /call-out >}}

{{<bootstrap-table "table table-responsive table-bordered">}}
{{< table >}}
| CLI flag | Environment variable | Description |
|---------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------|
| `--api-cert` | `NGINX_AGENT_API_CERT` | Specifies the certificate used by the Agent API. |
Expand Down Expand Up @@ -214,9 +214,7 @@ If you are upgrading from an older version, update your configuration accordingl
| `--tls-enable` | `NGINX_AGENT_TLS_ENABLE` | Enables TLS for secure communications. |
| `--tls-key` | `NGINX_AGENT_TLS_KEY` | Specifies the path to the certificate key file for TLS. |
| `--tls-skip-verify` | `NGINX_AGENT_TLS_SKIP_VERIFY` | Insecurely skips verification for gRPC TLS credentials. |
{{</bootstrap-table>}}

<br>
{{< /table >}}

{{< call-out "note" >}}
Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ git clone [email protected]:nginx/agent.git

### Download the NGINX Plus certificate and key {#myf5-download}

{{< fa "circle-info" "text-muted" >}} **This step is required if you are using NGINX Plus. If you are using NGINX open source, you can skip this section.**
{{< icon "circle-info" "text-muted" >}} **This step is required if you are using NGINX Plus. If you are using NGINX open source, you can skip this section.**

In order to build a container image with NGINX Plus, you must provide the SSL certificate and private key files provided with your NGINX Plus license. These files grant access to the package repository from which the script will download the NGINX Plus package.

Expand Down Expand Up @@ -175,15 +175,12 @@ The NGINX Agent GitHub repo has a set of Make commands that you can use to build

You can pass the following arguments when running the **make** command to build an NGINX Agent container image.

{{<bootstrap-table "table table-striped table-border">}}
| Argument | Definition |
| ---------------- | -------------------------|
| OS_RELEASE | The Linux distribution to use as the base image. <br>Can also be set in the repo Makefile.|
| OS_VERSION | The version of the Linux distribution to use as the base image. <br>Can also be set in the repo Makefile.|
| AGENT_VERSION | The versions of NGINX agent that you want installed on the image.|

{{</bootstrap-table>}}

### Build NGINX open source images

Run the following `make` command to build the default image, which uses Alpine as the base image:
Expand Down Expand Up @@ -213,6 +210,3 @@ To build an image with Debian and an older version of NGINX Agent you can run th
```shell
IMAGE_BUILD_TARGET=install-agent-repo NGINX_AGENT_VERSION=2.37.0~bullseye OS_RELEASE=debian OS_VERSION=bullseye-slim make image
```



Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,13 @@ After installing NGINX Plus, you can install NGINX agent following the steps on

Run the command corresponding to your operating system to start NGINX Agent:

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

| Operating System | Command(s) |
|------------------------------------------------------|------------------------------------------------|
| RHEL, CentOS,<br>Rocky Linux, AlmaLinux,<br>Oracle Linux, Ubuntu,<br>Debian, SLES, Amazon Linux | ```sudo systemctl start nginx-agent``` |
| Alpine Linux | ```sudo rc-service nginx-agent start```<br>or<br>```sudo /etc/init.d/nginx-agent start``` |
| FreeBSD | ```sudo service nginx-agent start``` |

{{</bootstrap-table>}}

You can confirm that NGINX Agent is running under the same user as NGINX Plus by running the following command:

```bash
Expand Down
10 changes: 2 additions & 8 deletions content/agent/technical-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,28 @@ This document describes the requirements for NGINX Agent version 2.
This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.

## NGINX Agent 3.0 Compatibility
{{< bootstrap-table "table table-striped table-bordered" >}}

| NGINX Product | Agent Version |
|------------------------------|----------------|
| **NGINX One Console** | 3.x |
| **NGINX Gateway Fabric** | 3.x |
| **NGINX Plus** | 2.x, 3.x |
| **NGINX Ingress Controller** | 2.x, 3.x |
| **NGINX Instance Manager** | 2.x |
{{< /bootstrap-table >}}

## Supported Distributions

NGINX Agent can run in most environments. We support the following distributions:

{{< bootstrap-table "table table-striped table-bordered" >}}
| | AlmaLinux | Alpine Linux | Amazon Linux | Amazon Linux 2| Debian |
|-|-----------|--------------|--------------|----------------|--------|
|**Version**|8 <br><hr>9 <br><hr>10| 3.19<br><hr>3.20<br><hr> 3.21<br><hr> 3.22| 2023| LTS| 11<br><hr> 12|
|**Architecture**| x86_84<br><hr>aarch64| x86_64<br><hr>aarch64 | x86_64<br><hr>aarch64 | x86_64<br><hr>aarch64 | x86_64<br><hr>aarch64 | x86_64<br><hr>aarch64 |
{{< /bootstrap-table >}}

{{< bootstrap-table "table table-striped table-bordered" >}}
| |FreeBSD | Oracle Linux | Red Hat <br>Enterprise Linux <br>(RHEL) | Rocky Linux | SUSE Linux <br>Enterprise Server <br>(SLES) | Ubuntu |
|-|--------|--------------|---------------------------------|-------------|-------------------------------------|--------|
|**Version**|13<br><hr>14|8.1+<br><hr>9<br><hr>10|8.1+<br><hr>9.0+<br><hr>10|8<br><hr>9<br><hr>10|15 SP2|22.04 LTS<br><hr>24.04 LTS<br><hr>25.04 LTS|
|**Architecture**|amd64|x86_64|x86_64<br><hr>aarch64|x86_64<br><hr>aarch64|x86_64|x86_64<br><hr>aarch64|
{{< /bootstrap-table >}}


## Supported deployment environments
Expand All @@ -57,11 +52,10 @@ NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plu
## Sizing recommendations

Minimum system sizing recommendations for NGINX Agent:
{{< bootstrap-table "table table-striped table-bordered" >}}

| CPU | Memory | Network | Storage |
|------------|----------|-----------|---------|
| 1 CPU core | 1 GB RAM | 1 GbE NIC | 20 GB |
{{< /bootstrap-table >}}

## Logging

Expand Down
2 changes: 0 additions & 2 deletions content/amplify/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,9 @@ nd-docs: DOCS-1692

### {{% icon-bug %}} Unable to add some NGINX HTTP requests metrics to custom graph {#631}

{{<bootstrap-table "table table-striped table-bordered">}}
| Issue ID | Status |
|----------|--------|
| 631 | Open |
{{</bootstrap-table>}}

#### Description

Expand Down
3 changes: 1 addition & 2 deletions content/controller/api/reference/ctlr-adc-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@ tags:
title: ADC API
toc: false
weight: 300
nd-api-reference: "./nginx-controller/api/reference/ctlr-adc-openapi.json"
---

{{< openapi spec="./nginx-controller/api/reference/ctlr-adc-openapi.json" >}}
3 changes: 1 addition & 2 deletions content/controller/api/reference/ctlr-analytics-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,5 @@ tags:
title: Analytics API
toc: false
weight: 200
nd-api-reference: "./nginx-controller/api/reference/ctlr-analytics-openapi.json"
---

{{< openapi spec="./nginx-controller/api/reference/ctlr-analytics-openapi.json" >}}
3 changes: 1 addition & 2 deletions content/controller/api/reference/ctlr-apim-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,5 @@ tags:
title: APIM API
toc: false
weight: 400
nd-api-reference: "./nginx-controller/api/reference/ctlr-apim-openapi.json"
---

{{< openapi spec="./nginx-controller/api/reference/ctlr-apim-openapi.json" >}}
3 changes: 1 addition & 2 deletions content/controller/api/reference/ctlr-platform-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,5 @@ tags:
- api
title: Platform API
toc: false
nd-api-reference: "./nginx-controller/api/reference/ctlr-platform-openapi.json"
---

{{< openapi spec="./nginx-controller/api/reference/ctlr-platform-openapi.json" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Take the steps below to create a new Authentication Provider by using the NGINX

## Set up an Microsoft Entra Auth Provider {#set-up-entra}

{{< fa "arrow-circle-right" >}} **Introduced in NGINX Controller ADC v3.22**
{{< icon "arrow-circle-right" >}} **Introduced in NGINX Controller ADC v3.22**

In the previous section, you selected **Microsoft Entra** from the **Authentication Provider Type** list. Next, you'll set up the Auth Provider so it can connect to Microsoft Entra.

Expand Down
4 changes: 2 additions & 2 deletions content/mesh/guides/monitoring-and-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ To use NGINX Service Mesh with your Prometheus deployment:
If you are deploying NGINX Plus Ingress Controller with the NGINX Service Mesh, add the `nginx-plus-ingress` scrape config as well.
Consult the [Metrics]( {{< ref "/mesh/tutorials/kic/deploy-with-kic.md#nginx-plus-ingress-controller-metrics" >}} ) section of the NGINX Ingress Controller Deployment tutorial for more information about the metrics collected.

- {{< fa "download" >}} {{< link "/examples/nginx-mesh-sidecars-scrape-config.yaml" "`nginx-mesh-sidecars-scrape-config.yaml`" >}}
- {{< fa "download" >}} {{< link "/examples/nginx-plus-ingress-scrape-config.yaml" "`nginx-plus-ingress-scrape-config.yaml`" >}}
- {{< icon "download" >}} {{< link "/examples/nginx-mesh-sidecars-scrape-config.yaml" "`nginx-mesh-sidecars-scrape-config.yaml`" >}}
- {{< icon "download" >}} {{< link "/examples/nginx-plus-ingress-scrape-config.yaml" "`nginx-plus-ingress-scrape-config.yaml`" >}}

{{< call-out "note" >}}
For more information on how to view and understand the metrics that we track, see our [Prometheus Metrics]({{< ref "prometheus-metrics.md" >}}) guide.
Expand Down
Loading
Loading