Skip to content

Commit cc7d215

Browse files
nginx-jacklamATnginxADubhlaoichTasoOneAsia
authored
Mainframe theme release updates (#1018)
* Fix catalog and home page * Homepage: Match mainframe branch updates * Homepage: Match mainframe css and layout setup * Rewrite main landing page to be in markdown + updated card shortcode usage (#818) feat: Rewrote main landing page to be in markdown + updated card shortcode usage * Refactored icon usage to use new shortcode (#801) * feat: Rewrote main landing page to be in markdown + updated card shortcode usage * Update card params correctly * chore: Refactored icon usage to use new shortcode * Removed brand icons * Removed final few brand icons * Add overview of nginx-org source ingestion * Update N1 landing page to use updated params * Remove fa usages in mesh * Redocly: Match updated mainframe redocly usage (#970) * Update card-layout usage (#979) * chore: Remove card-layout shortcode usage * chore: Update NIC docs * Remove NGINX Unit from home landing page (#981) chore: Remove NGINX Unit from home landing page * feat: Update tables This commit updates tables across the NGINX documentation set by removing the old bootstrap shortcode or replacing it with the new table one. Mainframe has better sensible defaults, so the scaffolding provided by the bootstrap shortcode is no longer necessary. * Remove card-layout from N+ landing page (#996) feat: Remove card-layout from N+ landing page * Rebase: Fixes post rebase * CardLayout: Fix post rebase * fix: Icon for N4A on home landing page * Fix: Missing line break after includes * Fix OSSC page on mainframe (#1026) fix: Render of ossc page + updated contents * Remove sidebar partial (#1031) chore: Remove sidebar partial * Fix NMS rendering on mainframe (#1030) fix: NMS rendering on mainframe * Fix rn-style shortcode usage issues in build (#1032) fix: Fix rn-style shortcode usage issues in build * ProductSelector: Add yaml * Mainframe: Cardlayout rebase for n1 workshop * Mainframe: Update yaml * Remove before-you-begin shortcode (#1036) chore: Remove before-you-begin shortcode * ProductSelector: Supply extUrl prop for external urls * ProductSelector: Fix casing * ProductSelector: Remove prefix / * ProductSelector: Remove prefix / * ProductSelector: Remove unit --------- Co-authored-by: Lam <150060045+lamATnginx@users.noreply.github.com> Co-authored-by: Lam Nguyen <la.nguyen@f5.com> Co-authored-by: Alan Dooley <a.dooley@f5.com> Co-authored-by: Michael McKeen <m.mckeen@f5.com>
1 parent 13df75c commit cc7d215

File tree

106 files changed

+693
-1654
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+693
-1654
lines changed

‎_banners/eos-nms.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{{< banner "warning" "End of Sale Notice:" >}}
2+
<br>
3+
<strong>This product is End of Sale.</strong> See our <a href="https://my.f5.com/manage/s/article/K000137989">End of Sale announcement</a> for more details.
4+
{{</ banner >}}

‎archetypes/landing-page.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,16 @@ nd-product:
3131
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
3232
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
3333

34-
{{<card-layout>}}
35-
{{<card-section showAsCards="true" isFeaturedSection="true">}}
36-
{{<card title="<some-title>">}}
37-
<!-- Each description should be roughly 10 words or less. -->
38-
{{</card>}}
39-
<!-- The titleURL and icon are both optional -->
40-
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
41-
{{<card title="<some-title>" titleUrl="<some-url>" icon="<some-lucide-icon>">}}
42-
<!-- Each description should be roughly 10 words or less. -->
43-
{{</card>}}
44-
{{</card-section>}}
45-
{{</card-layout>}}
34+
{{<card-section showAsCards="true" isFeaturedSection="true">}}
35+
{{<card title="<some-title>">}}
36+
<!-- Each description should be roughly 10 words or less. -->
37+
{{</card>}}
38+
<!-- The titleURL and icon are both optional -->
39+
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
40+
{{<card title="<some-title>" titleUrl="<some-url>" icon="<some-lucide-icon>">}}
41+
<!-- Each description should be roughly 10 words or less. -->
42+
{{</card>}}
43+
{{</card-section>}}
4644

4745
## Other content
4846

‎content/_index.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,48 @@
22
title: NGINX Product Documentation
33
description: Learn how to deliver, manage, and protect your applications using F5 NGINX products.
44
---
5+
6+
## NGINX Product Documentation
7+
Learn how to deliver, manage, and protect your applications using F5 NGINX products.
8+
9+
{{<card-section showAsCards="true" title="NGINX One">}}
10+
{{<card title="NGINX One Console" titleUrl="/nginx-one/" brandIcon="NGINX-One-product-icon.svg" isLanding="true">}}
11+
Monitor your infrastructure, address security vulnerabilities, and assess the health of your NGINX fleet, all from a single console.
12+
{{</card >}}
13+
{{<card title="NGINX Plus" titleUrl="/nginx/" brandIcon="NGINX-Plus-product-icon.svg" isLanding="true">}}
14+
The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.
15+
{{</card >}}
16+
{{<card title="NGINX Instance Manager" titleUrl="/nginx-instance-manager/" brandIcon="NGINX-Instance-Manager-product-icon.svg" isLanding="true">}}
17+
Track and control NGINX Open Source and NGINX Plus instances.
18+
{{</card >}}
19+
{{<card title="NGINX Ingress Controller" titleUrl="/nginx-ingress-controller/" brandIcon="NGINX-Ingress-Controller-product-icon.svg" isLanding="true">}}
20+
Kubernetes traffic management with API gateway, identity, and observability features.
21+
{{</card >}}
22+
{{<card title="NGINX Gateway Fabric" titleUrl="/nginx-gateway-fabric/" brandIcon="NGINX-Gateway-Fabric-product-icon.svg" isLanding="true">}}
23+
Next generation Kubernetes connectivity using the Gateway API.
24+
{{</card >}}
25+
{{<card title="NGINX Open Source" titleUrl="https://nginx.org/en/docs/" brandIcon="NGINX-Open-Source-product-icon.svg" isLanding="true">}}
26+
The open source all-in-one load balancer, content cache, and web server
27+
{{</card >}}
28+
{{<card title="NGINX Agent" titleUrl="/nginx-agent/" brandIcon="NGINX-Agent-product-icon.svg" isLanding="true">}}
29+
A daemon providing observability data and remote configuration for NGINX Open Source and NGINX Plus instances
30+
{{</card >}}
31+
{{<card title="Subscription Licensing & Solutions" titleUrl="/solutions/" brandIcon="NGINX-product-icon.svg" isLanding="true">}}
32+
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.
33+
{{</card >}}
34+
{{</card-section>}}
35+
36+
{{<card-section showAsCards="true" title="NGINX App Protect">}}
37+
{{<card title="NGINX App Protect WAF" titleUrl="/nginx-app-protect-waf/" brandIcon="NGINX-App-Protect-WAF-product-icon.svg" isLanding="true">}}
38+
Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs
39+
{{</card >}}
40+
{{<card title="NGINX App Protect DoS" titleUrl="/nginx-app-protect-dos/" brandIcon="NGINX-App-Protect-DoS-product-icon.svg" isLanding="true">}}
41+
Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs
42+
{{</card >}}
43+
{{</card-section>}}
44+
45+
{{<card-section showAsCards="true" title="NGINX as a Service">}}
46+
{{<card title="NGINX as a Service for Azure" titleUrl="/nginxaas/azure/" brandIcon="NGINX-for-Azure-product-icon.svg" isLanding="true">}}
47+
Infrastructure-as-a-Service (IaaS) version of NGINX Plus for your Microsoft Azure application stack
48+
{{</card >}}
49+
{{</card-section>}}

‎content/agent/_index.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -33,26 +33,22 @@ configurations, collection and reporting of real-time NGINX performance and oper
3333
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
3434
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
3535

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

49-
{{<card-layout>}}
50-
{{<card-section showAsCards="true" isFeaturedSection="true">}}
51-
{{<card title="Upgrade" titleUrl="/nginx-agent/installation-upgrade/upgrade/" icon="circle-fading-arrow-up">}}
52-
{{</card>}}
53-
{{<card title="Configuration" titleUrl="/nginx-agent/configuration" icon="cog">}}
54-
{{</card>}}
55-
{{<card title="Support" titleUrl="/nginx-agent/support" icon="hand-helping">}}
56-
{{</card>}}
57-
{{</card-section>}}
58-
{{</card-layout>}}
47+
{{<card-section showAsCards="true" isFeaturedSection="true">}}
48+
{{<card title="Upgrade" titleUrl="installation-upgrade/upgrade/" icon="circle-fading-arrow-up">}}
49+
{{</card>}}
50+
{{<card title="Configuration" titleUrl="configuration/" icon="cog">}}
51+
{{</card>}}
52+
{{<card title="Support" titleUrl="support/" icon="hand-helping">}}
53+
{{</card>}}
54+
{{</card-section>}}

‎content/agent/about.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ For NGINX Agent to work properly with an NGINX Plus instance, the API needs to b
4646
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:
4747

4848

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

6664

6765

‎content/agent/configuration/configuration-overview.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ If you are upgrading from an older version, update your configuration accordingl
177177

178178
{{< /call-out >}}
179179

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

221219
{{< call-out "note" >}}
222220
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.

‎content/agent/installation-upgrade/container-environments/docker-images.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ git clone git@github.com:nginx/agent.git
7777

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

80-
{{< 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.**
80+
{{< 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.**
8181

8282
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.
8383

@@ -175,15 +175,12 @@ The NGINX Agent GitHub repo has a set of Make commands that you can use to build
175175
176176
You can pass the following arguments when running the **make** command to build an NGINX Agent container image.
177177
178-
{{<bootstrap-table "table table-striped table-border">}}
179178
| Argument | Definition |
180179
| ---------------- | -------------------------|
181180
| OS_RELEASE | The Linux distribution to use as the base image. <br>Can also be set in the repo Makefile.|
182181
| OS_VERSION | The version of the Linux distribution to use as the base image. <br>Can also be set in the repo Makefile.|
183182
| AGENT_VERSION | The versions of NGINX agent that you want installed on the image.|
184183
185-
{{</bootstrap-table>}}
186-
187184
### Build NGINX open source images
188185
189186
Run the following `make` command to build the default image, which uses Alpine as the base image:
@@ -213,6 +210,3 @@ To build an image with Debian and an older version of NGINX Agent you can run th
213210
```shell
214211
IMAGE_BUILD_TARGET=install-agent-repo NGINX_AGENT_VERSION=2.37.0~bullseye OS_RELEASE=debian OS_VERSION=bullseye-slim make image
215212
```
216-
217-
218-

‎content/agent/installation-upgrade/installation-unprivileged.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,13 @@ After installing NGINX Plus, you can install NGINX agent following the steps on
4242

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

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

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

53-
{{</bootstrap-table>}}
54-
5552
You can confirm that NGINX Agent is running under the same user as NGINX Plus by running the following command:
5653

5754
```bash

‎content/agent/technical-specifications.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,28 @@ This document describes the requirements for NGINX Agent version 2.
1111
This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
1212

1313
## NGINX Agent 3.0 Compatibility
14-
{{< bootstrap-table "table table-striped table-bordered" >}}
14+
1515
| NGINX Product | Agent Version |
1616
|------------------------------|----------------|
1717
| **NGINX One Console** | 3.x |
1818
| **NGINX Gateway Fabric** | 3.x |
1919
| **NGINX Plus** | 2.x, 3.x |
2020
| **NGINX Ingress Controller** | 2.x, 3.x |
2121
| **NGINX Instance Manager** | 2.x |
22-
{{< /bootstrap-table >}}
2322

2423
## Supported Distributions
2524

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

28-
{{< bootstrap-table "table table-striped table-bordered" >}}
2927
| | AlmaLinux | Alpine Linux | Amazon Linux | Amazon Linux 2| Debian |
3028
|-|-----------|--------------|--------------|----------------|--------|
3129
|**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|
3230
|**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 |
33-
{{< /bootstrap-table >}}
3431

35-
{{< bootstrap-table "table table-striped table-bordered" >}}
3632
| |FreeBSD | Oracle Linux | Red Hat <br>Enterprise Linux <br>(RHEL) | Rocky Linux | SUSE Linux <br>Enterprise Server <br>(SLES) | Ubuntu |
3733
|-|--------|--------------|---------------------------------|-------------|-------------------------------------|--------|
3834
|**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|
3935
|**Architecture**|amd64|x86_64|x86_64<br><hr>aarch64|x86_64<br><hr>aarch64|x86_64|x86_64<br><hr>aarch64|
40-
{{< /bootstrap-table >}}
4136

4237

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

5954
Minimum system sizing recommendations for NGINX Agent:
60-
{{< bootstrap-table "table table-striped table-bordered" >}}
55+
6156
| CPU | Memory | Network | Storage |
6257
|------------|----------|-----------|---------|
6358
| 1 CPU core | 1 GB RAM | 1 GbE NIC | 20 GB |
64-
{{< /bootstrap-table >}}
6559

6660
## Logging
6761

‎content/amplify/known-issues.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,13 @@ toc: true
66
nd-docs: DOCS-1692
77
---
88

9-
{{<rn-styles>}}
10-
119
---
1210

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

15-
{{<bootstrap-table "table table-striped table-bordered">}}
1613
| Issue ID | Status |
1714
|----------|--------|
1815
| 631 | Open |
19-
{{</bootstrap-table>}}
2016

2117
#### Description
2218

0 commit comments

Comments
 (0)