|
| 1 | +--- |
| 2 | +description: '' |
| 3 | +title: 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 F5 NGINX. |
| 11 | + |
| 12 | +## General terms |
| 13 | + |
| 14 | +{{< table >}} |
| 15 | + |
| 16 | +| Term | Definition | |
| 17 | +| ---- | ---------- | |
| 18 | +| **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" >}}) | |
| 19 | +| **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. | |
| 20 | +| **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. | |
| 21 | +| **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. | |
| 22 | +| **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. | |
| 23 | +| **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. | |
| 24 | +| **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" >}}). | |
| 25 | +| **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). | |
| 26 | + |
| 27 | +{{< /table >}} |
| 28 | + |
| 29 | +## Authentication and Authorization terms |
| 30 | + |
| 31 | +{{< table >}} |
| 32 | + |
| 33 | +| Term | Definition | |
| 34 | +| ---- | ---------- | |
| 35 | +| **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). | |
| 36 | +| **ID Token** | Specific to OIDC, the primary use of the token in JWT format is to provide information about the authentication operation's outcome. | |
| 37 | +| **Identity Provider (IdP)** | A service that authenticates users and verifies their identity for client applications. | |
| 38 | +| **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. | |
| 39 | +| **Protected Resource** | A resource that is hosted by the resource server and requires an access token to be accessed. | |
| 40 | +| **Refresh Token** | Coming from OAuth2 specs, the token is usually long-lived and may be used to obtain new access tokens. | |
| 41 | +| **Relying Party (RP)** | A client service required to verify user identity. | |
| 42 | + |
| 43 | +{{< /table >}} |
| 44 | + |
| 45 | +## Kubernetes and Ingress Controller terms |
| 46 | + |
| 47 | +{{< include "nic/kubernetes-terminology.md" >}} |
| 48 | + |
| 49 | +## F5 WAF for NGINX |
| 50 | + |
| 51 | +This section defines terminology used when describing functionality of F5 WAF for NGINX. |
| 52 | + |
| 53 | +It assumes you are familiar with various layer 7 (L7) hypertext transfer protocol (HTTP) concepts such as: |
| 54 | + |
| 55 | +- Cookies |
| 56 | +- HTTP methods and status codes |
| 57 | +- HTTP headings, requests, responses, and parameters |
| 58 | +- Uniform Resource Identifier (URI) |
| 59 | +- Uniform Resource Location (URL) |
| 60 | + |
| 61 | +{{< include "waf/terminology.md" >}} |
| 62 | + |
| 63 | +## NGINX Alerts |
| 64 | + |
| 65 | +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/" >}}). |
| 66 | + |
| 67 | +{{< include "/nginx-one/alert-labels.md" >}} |
| 68 | + |
| 69 | + |
| 70 | +## References |
| 71 | + |
| 72 | +- [F5 Glossary](https://www.f5.com/glossary) |
| 73 | +- [F5 Distributed Cloud: Core Concepts](https://docs.cloud.f5.com/docs/ves-concepts/core-concepts) |
| 74 | + |
0 commit comments