Skip to content

Commit c54ecd9

Browse files
Fixed redundant glossary URL, removed NIC glossary page (#1581)
* Fixed redundant glossary URL, removed NIC glossary page
1 parent a4b08c9 commit c54ecd9

File tree

8 files changed

+85
-98
lines changed

8 files changed

+85
-98
lines changed

content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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/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.
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/nic/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ nd-product: INGRESS
2020

2121
## About
2222

23-
NGINX Ingress Controller is an [Ingress Controller]({{< ref "/nic/glossary.md#ingress-controller">}}) implementation for NGINX that can load balance Websocket, gRPC, TCP and UDP applications.
23+
NGINX Ingress Controller is an [Ingress Controller]({{< ref "/glossary/#k8s-ingress-controller">}}) implementation for NGINX that can load balance Websocket, gRPC, TCP and UDP applications.
2424

25-
It supports standard [Ingress]({{< ref "/nic/glossary.md#ingress">}}) features such as content-based routing and TLS/SSL termination. Several NGINX and NGINX Plus features are available as extensions to Ingress resources through [Annotations]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations">}}) and the [ConfigMap]({{< ref "/nic/configuration/global-configuration/configmap-resource">}}) resource.
25+
It supports standard [Ingress]({{< ref "/glossary/#k8s-ingress-controller">}}) features such as content-based routing and TLS/SSL termination. Several NGINX and NGINX Plus features are available as extensions to Ingress resources through [Annotations]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations">}}) and the [ConfigMap]({{< ref "/nic/configuration/global-configuration/configmap-resource">}}) resource.
2626

2727
## Featured content
2828

content/nic/glossary.md

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

content/nic/install/migrate-ingress-nginx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For more information, you may want to read the two-part blog series from the [NG
2626

2727
To complete the instructions in this guide, you need the following:
2828

29-
- A working knowledge of [Ingress Controllers]({{< ref "/nic/glossary.md#ingress-controller-ingress-controller" >}}).
29+
- A working knowledge of [Ingress Controllers]({{< ref "/glossary/#k8s-ingress-controller" >}}).
3030
- An [NGINX Ingress Controller installation]({{< ref "/nic/install/" >}}) on the same host as an existing Ingress-NGINX Controller.
3131

3232
There are two primary paths for migrating between the community Ingress-NGINX Controller to NGINX Ingress Controller:

content/nic/overview/about.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ nd-docs: DOCS-612
88

99
This document describes the F5 NGINX Ingress Controller, an Ingress Controller implementation for NGINX and NGINX Plus.
1010

11-
NGINX Ingress Controller is an [Ingress Controller]({{< ref "/nic/glossary.md#ingress-controller">}}) implementation for [NGINX](https://nginx.org) and [NGINX Plus](https://www.f5.com/products/nginx/nginx-plus) that can load balance Websocket, gRPC, TCP and UDP applications. NGINX Ingress Controller gives you a way to manage NGINX through the [Kubernetes](https://kubernetes.io/) API, and is built to handle the continuous change that happens in Kubernetes environments.
11+
NGINX Ingress Controller is an [Ingress Controller]({{< ref "/glossary/#k8s-ingress-controller">}}) implementation for [NGINX](https://nginx.org) and [NGINX Plus](https://www.f5.com/products/nginx/nginx-plus) that can load balance Websocket, gRPC, TCP and UDP applications. NGINX Ingress Controller gives you a way to manage NGINX through the [Kubernetes](https://kubernetes.io/) API, and is built to handle the continuous change that happens in Kubernetes environments.
1212

13-
It supports standard [Ingress]({{< ref "/nic/glossary.md#ingress">}}) features such as content-based routing and TLS/SSL termination. Several NGINX and NGINX Plus features are available as extensions to Ingress resources through [Annotations]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations">}}) and the [ConfigMap]({{< ref "/nic/configuration/global-configuration/configmap-resource">}}) resource.
13+
It supports standard [Ingress]({{< ref "/glossary/#k8s-ingress-controller">}}) features such as content-based routing and TLS/SSL termination. Several NGINX and NGINX Plus features are available as extensions to Ingress resources through [Annotations]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations">}}) and the [ConfigMap]({{< ref "/nic/configuration/global-configuration/configmap-resource">}}) resource.
1414

1515
NGINX Ingress Controller supports the [VirtualServer and VirtualServerRoute resources]({{< ref "/nic/configuration/virtualserver-and-virtualserverroute-resources">}}) as alternatives to Ingress, enabling traffic splitting and advanced content-based routing. It also supports TCP, UDP and TLS Passthrough load balancing using [TransportServer resources]({{< ref "/nic/configuration/transportserver-resource">}}).
1616

0 commit comments

Comments
 (0)