Skip to content

Commit 53a429b

Browse files
ChisomUmaChisomUma
committed
docs: consolidate glossary pages
1 parent ab184bd commit 53a429b

File tree

5 files changed

+89
-3
lines changed

5 files changed

+89
-3
lines changed

‎content/_index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,11 @@ Learn how to deliver, manage, and protect your applications using F5 NGINX produ
5050
Managed NGINX service for your Google Cloud application stack.
5151
{{</card >}}
5252
{{</card-section>}}
53+
54+
{{<card-section showAsCards="true" title="Glossary">}}
55+
{{<card title="F5 NGINX Glossary" titleUrl="/glossary/glossary/" brandIcon="NGINX-product-icon.svg" isLanding="true">}}
56+
Glossary of common terms and definitions for all F5 NGINX products.
57+
{{</card >}}
58+
{{</card-section>}}
59+
60+

‎content/glossary/_index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Glossary"
3+
weight: 100
4+
---

‎content/glossary/glossary.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
description: ''
3+
title: F5 NGINX Glossary
4+
nd-docs: DOCS-602
5+
weight: 1000
6+
toc: true
7+
nd-content-type: reference
8+
---
9+
10+
This glossary defines terms used in the F5 NGINX One Console and F5 Distributed Cloud.
11+
12+
## General terms
13+
14+
{{<bootstrap-table "table table-striped table-bordered">}}
15+
| Term | Definition |
16+
|-------------|-------------|
17+
| **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" >}}) |
18+
| **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. |
19+
| **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. |
20+
| **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. |
21+
| **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. |
22+
| **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. |
23+
| **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" >}}). |
24+
| **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). |
25+
{{</bootstrap-table>}}
26+
27+
## Authentication and Authorization terms
28+
29+
{{<bootstrap-table "table table-striped table-bordered">}}
30+
| Term | Definition |
31+
|-------------|-------------|
32+
| **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). |
33+
| **ID Token** | Specific to OIDC, the primary use of the token in JWT format is to provide information about the authentication operation's outcome. |
34+
| **Identity Provider (IdP)** | A service that authenticates users and verifies their identity for client applications. |
35+
| **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. |
36+
| **Protected Resource** | A resource that is hosted by the resource server and requires an access token to be accessed. |
37+
| **Refresh Token** | Coming from OAuth2 specs, the token is usually long-lived and may be used to obtain new access tokens. |
38+
| **Relying Party (RP)** | A client service required to verify user identity. |
39+
{{</bootstrap-table>}}
40+
41+
## Kubernetes and Ingress Controller terms
42+
43+
{{<bootstrap-table "table table-striped table-bordered">}}
44+
| Term | Definition |
45+
|-------------|-------------|
46+
| **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/). |
47+
| **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. |
48+
{{</bootstrap-table>}}
49+
50+
## F5 WAF for NGINX terminology
51+
52+
{{< include "nap-waf/config/common/nginx-app-protect-waf-terminology.md" >}}
53+
54+
## NGINX Alerts
55+
56+
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/" >}}).
57+
58+
{{< include "/nginx-one/alert-labels.md" >}}
59+
60+
61+
## Legal notice: Licensing agreements for NGINX products
62+
63+
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.
64+
65+
---
66+
67+
## References
68+
69+
- [F5 Glossary](https://www.f5.com/glossary)
70+
- [F5 Distributed Cloud: Core Concepts](https://docs.cloud.f5.com/docs/ves-concepts/core-concepts)
71+

‎content/nginx-one/glossary.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ This glossary defines terms used in the F5 NGINX One Console and F5 Distributed
1818
| **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. |
1919
| **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. |
2020
| **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. |
21-
| **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>/`.
22-
23-
To switch an instance between namespaces, you have to deregister an instance from an old namespace, and register it on the new namespace. |
21+
| **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. |
2422
| **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. |
2523
| **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" >}}). |
2624
| **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). |

‎data/product-selector.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,8 @@
2929
url: "nginxaas/azure/"
3030
- title: "NGINXaaS for Google Cloud"
3131
url: "nginxaas/google/"
32+
33+
- productGroup: Glossary
34+
products:
35+
- title: "F5 NGINX Glossary"
36+
url: "glossary"

0 commit comments

Comments
 (0)