Glossary
This glossary defines terms used in the F5 NGINX One Console 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 |
| 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/<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. | | 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. | | 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). |
To set up NGINX Alerts through the F5 Distributed Cloud, follow the procedure in Set up security alerts.
You can configure a variety of NGINX alerts in the F5 Distributed Cloud. If you have access to the F5 Distributed Cloud, log in and select the Audit Logs & Alerts tile.
Go to Notifications > Alerts. Select the gear icon and select Alert Name > Active Alerts. You may see one or more of the following alerts in the Audit Logs & Alerts Console.
| Alertname | Description | Alert Level | Action |
|---|---|---|---|
| HighCVENGINX | A high-severity CVE is impacting an NGINX instance | Critical | Review the CVE details in the NGINX One Console. Apply updates or change configurations to resolve the vulnerability. |
| MediumCVENGINX | A medium-severity CVE is impacting an NGINX instance | Major | Review the CVE details in the NGINX One Console. Apply updates or configuration changes as needed. |
| LowCVENGINX | A low-severity CVE is impacting an NGINX instance | Minor | Review the CVE details in the NGINX One Console. Consider updates or configuration changes to maintain security. |
| SecurityRecommendationNGINX | A security recommendation has been found for an NGINX configuration | Critical | Review the configuration issue in the NGINX One Console. Follow the recommendations to secure the instance or Config Sync Group. |
| OptimizationRecommendationNGINX | An optimization recommendation has been found for an NGINX configuration | Major | Review the optimization details in the NGINX One Console. Update the configuration to for the instance or Config Sync Group to enhance performance. |
| BestPracticeRecommendationNGINX | A best practice recommendation has been found for an NGINX configuration | Minor | Review the best practice recommendation in the NGINX One Console. Update the configuration for the instance or Config Sync Group to align with industry standards. |
| NGINXOffline | An NGINX instance is now offline | Major | Verify the host is online. Check the NGINX Agent’s status on the instance and ensure it is connected to the NGINX One Console. |
| NGINXUnavailable | An NGINX instance is now unavailable | Major | Ensure the NGINX Agent and host are active. Verify the NGINX Agent can connect to the NGINX One Console and resolve any network issues. |
| NewNGINX | A new NGINX instance has connected to NGINX One | Minor | Review the instance details in the NGINX One Console. Confirm availability, CVEs, and recommendations to ensure the instance is operational. |
| NGINXCertificateExpired | A certificate on an NGINX instance or Config Sync Group has expired | Critical | Get a new certificate from your certificate authority, then update the TLS/SSL certificate in the NGINX One Console. |
| NGINXCertificateExpiring | A certificate on an NGINX instance or Config Sync Group will expire soon | Major | Renew the certificate through your certificate authority, then update the TLS/SSL certificate in the NGINX One Console. |
Using NGINX One is subject to our End User Service Agreement (EUSA). For NGINX Plus, usage is governed by the End User License Agreement (EULA). Open source projects, including NGINX Agent and NGINX Open Source, are covered under their respective licenses. For more details on these licenses, follow the provided links.