From 53a429b99540c13c4a94529d4f5d28923ea22724 Mon Sep 17 00:00:00 2001 From: ChisomUma Date: Mon, 27 Oct 2025 04:15:46 +0100 Subject: [PATCH 1/4] docs: consolidate glossary pages --- content/_index.md | 8 ++++ content/glossary/_index.md | 4 ++ content/glossary/glossary.md | 71 +++++++++++++++++++++++++++++++++++ content/nginx-one/glossary.md | 4 +- data/product-selector.yaml | 5 +++ 5 files changed, 89 insertions(+), 3 deletions(-) create mode 100644 content/glossary/_index.md create mode 100644 content/glossary/glossary.md diff --git a/content/_index.md b/content/_index.md index ba5fe7d35..ddabc2178 100644 --- a/content/_index.md +++ b/content/_index.md @@ -50,3 +50,11 @@ Learn how to deliver, manage, and protect your applications using F5 NGINX produ Managed NGINX service for your Google Cloud application stack. {{}} {{}} + +{{}} + {{}} + Glossary of common terms and definitions for all F5 NGINX products. + {{}} +{{}} + + diff --git a/content/glossary/_index.md b/content/glossary/_index.md new file mode 100644 index 000000000..606ce2fb6 --- /dev/null +++ b/content/glossary/_index.md @@ -0,0 +1,4 @@ +--- +title: "Glossary" +weight: 100 +--- \ No newline at end of file diff --git a/content/glossary/glossary.md b/content/glossary/glossary.md new file mode 100644 index 000000000..38a6d75a4 --- /dev/null +++ b/content/glossary/glossary.md @@ -0,0 +1,71 @@ +--- +description: '' +title: F5 NGINX Glossary +nd-docs: DOCS-602 +weight: 1000 +toc: true +nd-content-type: reference +--- + +This glossary defines terms used in the F5 NGINX One Console and F5 Distributed Cloud. + +## General terms + +{{}} +| Term | Definition | +|-------------|-------------| +| **Config Sync 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. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) | +| **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. | +| **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. | +| **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, you need to use a data plane key. | +| **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//`. To switch an instance between namespaces, you have to deregister an instance from an old namespace, and register it on the new namespace. | +| **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. | +| **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/api/api-reference-guide/#tag/StagedConfigs" >}}). | +| **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). | +{{}} + +## Authentication and Authorization terms + +{{}} +| Term | Definition | +|-------------|-------------| +| **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). | +| **ID Token** | Specific to OIDC, the primary use of the token in JWT format is to provide information about the authentication operation's outcome. | +| **Identity Provider (IdP)** | A service that authenticates users and verifies their identity for client applications. | +| **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. | +| **Protected Resource** | A resource that is hosted by the resource server and requires an access token to be accessed. | +| **Refresh Token** | Coming from OAuth2 specs, the token is usually long-lived and may be used to obtain new access tokens. | +| **Relying Party (RP)** | A client service required to verify user identity. | +{{}} + +## Kubernetes and Ingress Controller terms + +{{}} +| Term | Definition | +|-------------|-------------| +| **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:
* **Load balancing**, extended through the use of Services
* **Content-based routing**, using hosts and paths
* **TLS/SSL termination**, based on hostnames

For additional information, please read the official [Kubernetes Ingress Documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/). | +| **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. | +{{}} + +## F5 WAF for NGINX terminology + +{{< include "nap-waf/config/common/nginx-app-protect-waf-terminology.md" >}} + +## NGINX Alerts + +To set up NGINX Alerts through the F5 Distributed Cloud, follow the procedure in [Set up security alerts]({{< ref "/nginx-one/secure-your-fleet/set-up-security-alerts/" >}}). + +{{< include "/nginx-one/alert-labels.md" >}} + + +## Legal notice: Licensing agreements for NGINX products + +Using NGINX One is subject to our End User Service Agreement (EUSA). For [NGINX Plus]({{< ref "/nginx" >}}), usage is governed by the End User License Agreement (EULA). Open source projects, including [NGINX Agent](https://github.com/nginx/agent) and [NGINX Open Source](https://github.com/nginx/nginx), are covered under their respective licenses. For more details on these licenses, follow the provided links. + +--- + +## References + +- [F5 Glossary](https://www.f5.com/glossary) +- [F5 Distributed Cloud: Core Concepts](https://docs.cloud.f5.com/docs/ves-concepts/core-concepts) + diff --git a/content/nginx-one/glossary.md b/content/nginx-one/glossary.md index a7acd408d..214862539 100644 --- a/content/nginx-one/glossary.md +++ b/content/nginx-one/glossary.md @@ -18,9 +18,7 @@ This glossary defines terms used in the F5 NGINX One Console and F5 Distributed | **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. | | **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. | | **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, you need to use a data plane key. | -| **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//`. - -To switch an instance between namespaces, you have to deregister an instance from an old namespace, and register it on the new namespace. | +| **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//`. To switch an instance between namespaces, you have to deregister an instance from an old namespace, and register it on the new namespace. | | **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. | | **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/api/api-reference-guide/#tag/StagedConfigs" >}}). | | **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). | diff --git a/data/product-selector.yaml b/data/product-selector.yaml index 64089bc1d..9f35fa664 100644 --- a/data/product-selector.yaml +++ b/data/product-selector.yaml @@ -29,3 +29,8 @@ url: "nginxaas/azure/" - title: "NGINXaaS for Google Cloud" url: "nginxaas/google/" + +- productGroup: Glossary + products: + - title: "F5 NGINX Glossary" + url: "glossary" \ No newline at end of file From 4a43b387dc9a52561606b33d30cb676d8accc2c4 Mon Sep 17 00:00:00 2001 From: ChisomUma Date: Mon, 27 Oct 2025 04:38:22 +0100 Subject: [PATCH 2/4] edit --- content/glossary/_index.md | 2 +- content/glossary/glossary.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/glossary/_index.md b/content/glossary/_index.md index 606ce2fb6..0240b512c 100644 --- a/content/glossary/_index.md +++ b/content/glossary/_index.md @@ -1,4 +1,4 @@ --- -title: "Glossary" +title: "F5 NGINX Glossary" weight: 100 --- \ No newline at end of file diff --git a/content/glossary/glossary.md b/content/glossary/glossary.md index 38a6d75a4..3c852e6da 100644 --- a/content/glossary/glossary.md +++ b/content/glossary/glossary.md @@ -1,13 +1,13 @@ --- description: '' -title: F5 NGINX Glossary +title: Glossary nd-docs: DOCS-602 weight: 1000 toc: true nd-content-type: reference --- -This glossary defines terms used in the F5 NGINX One Console and F5 Distributed Cloud. +This glossary defines terms used in the F5 NGINX and F5 Distributed Cloud. ## General terms From 6391c6bcaf0bd052450806ddc8f31c09c5d95406 Mon Sep 17 00:00:00 2001 From: ChisomUma Date: Wed, 29 Oct 2025 08:29:54 +0100 Subject: [PATCH 3/4] updated glossary --- content/glossary/glossary.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/glossary/glossary.md b/content/glossary/glossary.md index 3c852e6da..45a84fa2a 100644 --- a/content/glossary/glossary.md +++ b/content/glossary/glossary.md @@ -14,12 +14,12 @@ This glossary defines terms used in the F5 NGINX and F5 Distributed Cloud. {{}} | Term | Definition | |-------------|-------------| -| **Config Sync 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. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) | +| **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/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) | | **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. | | **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. | -| **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, you need to use a data plane key. | +| **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. | | **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//`. To switch an instance between namespaces, you have to deregister an instance from an old namespace, and register it on the new namespace. | -| **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. | +| **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. | | **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/api/api-reference-guide/#tag/StagedConfigs" >}}). | | **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). | {{}} From 48d0b9920e15353b04ed172001716a9aa8695dc5 Mon Sep 17 00:00:00 2001 From: Chisom Uma Date: Wed, 29 Oct 2025 14:43:22 +0100 Subject: [PATCH 4/4] Update content/glossary/glossary.md Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com> --- content/glossary/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/glossary/glossary.md b/content/glossary/glossary.md index 45a84fa2a..26d2e45c0 100644 --- a/content/glossary/glossary.md +++ b/content/glossary/glossary.md @@ -7,7 +7,7 @@ toc: true nd-content-type: reference --- -This glossary defines terms used in the F5 NGINX and F5 Distributed Cloud. +This glossary defines terms used in F5 NGINX. ## General terms