Skip to content

Commit defca19

Browse files
authored
Merge branch 'main' into waf/missing-prerequisite
2 parents 8ad5ae9 + ecbc5b3 commit defca19

File tree

186 files changed

+706
-850
lines changed

Some content is hidden

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

186 files changed

+706
-850
lines changed

content/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: F5 NGINX Product Documentation
33
description: Learn how to deliver, manage, and protect your applications using F5 NGINX products.
44
---
55

6-
# F5 NGINX Product Documentation
7-
Learn how to deliver, manage, and protect your applications using F5 NGINX products.
6+
# F5 NGINX Product Documentation
7+
Learn how to deliver, manage, and protect your applications using F5 NGINX products.
88

99
{{<card-section showAsCards="true" title="F5 NGINX One">}}
1010
{{<card title="F5 NGINX One Console" titleUrl="/nginx-one-console/" brandIcon="NGINX-One-product-icon.svg" isLanding="true">}}
@@ -52,7 +52,7 @@ Learn how to deliver, manage, and protect your applications using F5 NGINX produ
5252
{{</card-section>}}
5353

5454
{{<card-section showAsCards="true" title="Glossary">}}
55-
{{<card title="F5 NGINX Glossary" titleUrl="/glossary/glossary/" brandIcon="NGINX-product-icon.svg" isLanding="true">}}
55+
{{<card title="F5 NGINX Glossary" titleUrl="/glossary/" brandIcon="NGINX-product-icon.svg" isLanding="true">}}
5656
Glossary of common terms and definitions for all F5 NGINX products.
5757
{{</card >}}
5858
{{</card-section>}}

content/agent/technical-specifications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ NGINX Agent can run in most environments. We support the following distributions
2727

2828
| | AlmaLinux | Alpine Linux | Amazon Linux | Amazon Linux 2| Debian |
2929
|-|-----------|--------------|--------------|----------------|--------|
30-
|**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|
30+
|**Version**|8 <br><hr>9 <br><hr>10| 3.20<br><hr> 3.21<br><hr> 3.22<br><hr> 3.23| 2023| LTS| 11<br><hr> 12|
3131
|**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 |
3232

3333
| |FreeBSD | Oracle Linux | Red Hat <br>Enterprise Linux <br>(RHEL) | Rocky Linux | SUSE Linux <br>Enterprise Server <br>(SLES) | Ubuntu |

content/glossary/_index.md

Lines changed: 76 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,77 @@
11
---
2-
title: "F5 NGINX Glossary"
3-
weight: 100
4-
---
2+
description: ''
3+
title: F5 NGINX Glossary
4+
nd-docs: DOCS-602
5+
weight: 1000
6+
toc: true
7+
nd-content-type: reference
8+
nd-product: MISCEL
9+
nd-landing-page: true
10+
url: /glossary/
11+
---
12+
13+
This glossary defines terms used in F5 NGINX.
14+
15+
## General terms
16+
17+
{{< table >}}
18+
19+
| Term | Definition |
20+
| ---- | ---------- |
21+
| **Config Sync Group** / **Instance Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. Also known as an Instance Group in NGINX Instance Manager. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one-console/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |
22+
| **Control Plane** | The control plane is the part of a network architecture that manages and controls the flow or data or traffic (the Data Plane). It is responsible for system-level tasks such as routing and traffic management. |
23+
| **Data Plane** | The data plane is the part of a network architecture that carries user traffic. It handles tasks like forwarding data packets between devices and managing network communication. In the context of NGINX, the data plane is responsible for tasks such as load balancing, caching, and serving web content. |
24+
| **Instance** | An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One Console, you need to use a data plane key. |
25+
| **Namespace** | In F5 Distributed Cloud, a namespace groups a tenant's configuration objects, similar to administrative domains. Every object in a namespace must have a unique name, and each namespace must be unique to its tenant. This setup ensures isolation, preventing cross-referencing of objects between namespaces. You'll see the namespace in the NGINX One Console URL as `/namespaces/<namespace name>/`. To switch an instance between namespaces, you have to deregister an instance from an old namespace, and register it on the new namespace. |
26+
| **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. NGINX Agent also enables communication with NGINX Instance Manager. |
27+
| **Staged Configurations** | Also known as **Staged Configs**. Allows you to save "work in progress." You can create it from scratch, an Instance, another Staged Config, or a Config Sync Group. It does _not_ have to be a working configuration until you publish it to an instance or a Config Sync Group. You can even manage your **Staged Configurations** through our [API]({{< ref "/nginx-one-console/api/api-reference-guide/#tag/StagedConfigs" >}}). |
28+
| **Tenant** | A tenant in F5 Distributed Cloud is an entity that owns a specific set of configuration and infrastructure. It is fundamental for isolation, meaning a tenant cannot access objects or infrastructure of other tenants. Tenants can be either individual or enterprise, with the latter allowing multiple users with role-based access control (RBAC). |
29+
30+
{{< /table >}}
31+
32+
## Authentication and Authorization terms
33+
34+
{{< table >}}
35+
36+
| Term | Definition |
37+
| ---- | ---------- |
38+
| **Access Token** | Defined in OAuth2, this (optional) short lifetime token provides access to specific user resources as defined in the scope values in the request to the authorization server (can be a JSON token as well). |
39+
| **ID Token** | Specific to OIDC, the primary use of the token in JWT format is to provide information about the authentication operation's outcome. |
40+
| **Identity Provider (IdP)** | A service that authenticates users and verifies their identity for client applications. |
41+
| **JSON Web Token (JWT)** | An open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. This information can be verified and trusted because it is digitally signed. |
42+
| **Protected Resource** | A resource that is hosted by the resource server and requires an access token to be accessed. |
43+
| **Refresh Token** | Coming from OAuth2 specs, the token is usually long-lived and may be used to obtain new access tokens. |
44+
| **Relying Party (RP)** | A client service required to verify user identity. |
45+
46+
{{< /table >}}
47+
48+
## Kubernetes and Ingress Controller terms {#k8s-ingress-controller}
49+
50+
{{< include "nic/kubernetes-terminology.md" >}}
51+
52+
## F5 WAF for NGINX
53+
54+
This section defines terminology used when describing functionality of F5 WAF for NGINX.
55+
56+
It assumes you are familiar with various layer 7 (L7) hypertext transfer protocol (HTTP) concepts such as:
57+
58+
- Cookies
59+
- HTTP methods and status codes
60+
- HTTP headings, requests, responses, and parameters
61+
- Uniform Resource Identifier (URI)
62+
- Uniform Resource Location (URL)
63+
64+
{{< include "waf/terminology.md" >}}
65+
66+
## NGINX Alerts
67+
68+
To set up NGINX Alerts through the F5 Distributed Cloud, follow the procedure in [Set up security alerts]({{< ref "/nginx-one-console/secure-your-fleet/set-up-security-alerts/" >}}).
69+
70+
{{< include "/nginx-one-console/alert-labels.md" >}}
71+
72+
73+
## References
74+
75+
- [F5 Glossary](https://www.f5.com/glossary)
76+
- [F5 Distributed Cloud: Core Concepts](https://docs.cloud.f5.com/docs/ves-concepts/core-concepts)
77+

content/glossary/glossary.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

content/includes/nginxaas-azure/ncu-description.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ An NGINX Capacity Unit (NCU) quantifies the capacity of an NGINX instance based
1010
An NGINX Capacity Unit consists of the following parameters:
1111

1212
* CPU: an NCU provides 20 [Azure Compute Units](https://learn.microsoft.com/en-us/azure/virtual-machines/acu) (ACUs)
13-
* Bandwidth: an NCU provides 60 Mbps of network throughput
14-
* Concurrent connections: an NCU provides 400 concurrent connections. This performance is not guaranteed when F5 WAF for NGINX is used with NGINXaaS
13+
* Bandwidth: an NCU provides 2.2 Mbps of network throughput
14+
* Concurrent connections: an NCU provides 3000 concurrent connections. This performance is not guaranteed when F5 WAF for NGINX is used with NGINXaaS

content/includes/nginxaas-google/supported-regions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ NGINXaaS for Google Cloud is supported in the following regions per geography:
1212
|NGINXaaS Geography | Google Cloud Regions |
1313
|-----------|---------|
1414
| US | us-east1, us-east4, us-west1, us-west2, us-west3, us-west4, us-central1 |
15-
| EU | europe-west1, europe-west2 |
15+
| EU | europe-west1, europe-west2, europe-west4, europe-north1 |
1616
{{< /table >}}
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
nd-files:
33
- content/glossary/glossary.md
4-
- content/nic/glossary.md
4+
- content/glossary/
55
---
66

77
{{< table >}}
88

99
| Term | Definition |
1010
| ---- | ---------- |
11-
| **Ingress** | Refers to an *Ingress Resource*, a Kubernetes API object which allows access to [Services](https://kubernetes.io/docs/concepts/services-networking/service/) within a cluster. They are managed by an [Ingress Controller]({{< ref "/nic/glossary.md#ingress-controller">}}). *Ingress* resources enable the following functionality:<br>* **Load balancing**, extended through the use of Services<br>* **Content-based routing**, using hosts and paths<br>* **TLS/SSL termination**, based on hostnames<br><br>For additional information, please read the official [Kubernetes Ingress Documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/). |
12-
| **Ingress Controller** | Ingress Controllers are applications within a Kubernetes cluster that enable [Ingress]({{< ref "/nic/glossary.md#ingress">}}) resources to function. They are not automatically deployed with a Kubernetes cluster, and can vary in implementation based on intended use, such as load balancing algorithms for Ingress resources. [The design of NGINX Ingress Controller]({{< ref "/nic/overview/design.md">}}) explains the technical details of NGINX Ingress Controller. |
11+
| **Ingress** | Refers to an *Ingress Resource*, a Kubernetes API object which allows access to [Services](https://kubernetes.io/docs/concepts/services-networking/service/) within a cluster. They are managed by an [Ingress Controller]({{< ref "/glossary/#ingress-controller">}}). *Ingress* resources enable the following functionality:<br>* **Load balancing**, extended through the use of Services<br>* **Content-based routing**, using hosts and paths<br>* **TLS/SSL termination**, based on hostnames<br><br>For additional information, please read the official [Kubernetes Ingress Documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/). |
12+
| **Ingress Controller** | Ingress Controllers are applications within a Kubernetes cluster that enable [Ingress]({{< ref "/glossary/#ingress">}}) resources to function. They are not automatically deployed with a Kubernetes cluster, and can vary in implementation based on intended use, such as load balancing algorithms for Ingress resources. [The design of NGINX Ingress Controller]({{< ref "/nic/overview/design.md">}}) explains the technical details of NGINX Ingress Controller. |
1313

1414
{{< /table >}}

content/nginx-one-console/agent/overview/tech-specs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ and performance aligned with the NGINX core platform:
1717
| Distribution | Supported on Agent |
1818
|-------------------------------------|------------------------------------------------------------------------------------------------------------|
1919
| AlmaLinux | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) <br> 10 (x86_64, aarch64) **(new)** |
20-
| Alpine Linux | 3.19 (x86_64, aarch64) <br> 3.20 (x86_64, aarch64) <br> 3.21 (x86_64, aarch64) <br> 3.22 (x86_64, aarch64) |
20+
| Alpine Linux | 3.20 (x86_64, aarch64) <br> 3.21 (x86_64, aarch64) <br> 3.22 (x86_64, aarch64) <br> 3.23 (x86_64, aarch64) |
2121
| Amazon Linux | 2023 (x86_64, aarch64) |
2222
| Amazon Linux 2 | LTS (x86_64, aarch64) |
2323
| CentOS | **Not supported** |

content/nginxaas-azure/app-protect/enable-waf.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ nd-product: NAZURE
1212
This guide explains how to enable F5 WAF for NGINX on a F5 NGINX as a Service for Azure (NGINXaaS) deployment. [F5 WAF for NGINX](https://docs.nginx.com/nginx-app-protect-waf/v5) provides web application firewall (WAF) security protection for your web applications, including OWASP Top 10; response inspection; Meta characters check; HTTP protocol compliance; evasion techniques; disallowed file types; JSON & XML well-formedness; sensitive parameters & Data Guard.
1313

1414
## Before you start
15-
- F5 WAF for NGINX can only be enabled on NGINXaaS for Azure deployments with the **Standard v2** [plan]({{< ref "/nginxaas-azure/billing/overview.md" >}})
15+
16+
- F5 WAF for NGINX can only be enabled on NGINXaaS for Azure deployments with the **Standard v2** and **Standard v3** [plan]({{< ref "/nginxaas-azure/billing/overview.md" >}})
1617

1718
## Enable F5 WAF for NGINX
1819

0 commit comments

Comments
 (0)