|
| 1 | +--- |
| 2 | +title: "Explore NGINX One Console features" |
| 3 | +weight: 300 |
| 4 | +toc: true |
| 5 | +nd-content-type: tutorial |
| 6 | +nd-product: nginx-one |
| 7 | +--- |
| 8 | + |
| 9 | +## Introduction |
| 10 | + |
| 11 | +This guide shows you how to explore and use key NGINX One Console features: |
| 12 | + |
| 13 | +- Overview dashboard |
| 14 | +- TLS certificate management |
| 15 | +- Configuration recommendations |
| 16 | +- CVE scanning |
| 17 | +- AI Assistant for config insights |
| 18 | + |
| 19 | +You’ll see how each feature helps you monitor and secure your NGINX fleet without writing custom scripts. |
| 20 | + |
| 21 | +## What you’ll learn |
| 22 | + |
| 23 | +By the end of this tutorial, you’ll know how to: |
| 24 | + |
| 25 | +- Navigate the Overview Dashboard panels |
| 26 | +- View and filter certificate status |
| 27 | +- Review and apply config recommendations |
| 28 | +- Investigate CVEs and jump to details |
| 29 | +- Use the AI Assistant to explain directives and variables |
| 30 | + |
| 31 | +## Before you begin |
| 32 | + |
| 33 | +Make sure you have: |
| 34 | + |
| 35 | +- An F5 Distributed Cloud (XC) account with NGINX One enabled |
| 36 | +- All containers from Lab 2 running and registered |
| 37 | +- Basic NGINX and Linux knowledge |
| 38 | +- Your `$NAME` environment variable set (from [Lab 2]({{< ref "nginx-one/workshops/lab2/run-workshop-components-with-docker.md" >}})) |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +## 1. Overview Dashboard panels |
| 43 | + |
| 44 | +Open NGINX One Console and select **Overview**. Here are the key metrics you’ll see and what they tell you: |
| 45 | + |
| 46 | +<span style="display: inline-block;"> |
| 47 | +{{< img src="nginx-one/images/nginx-one-dashboard.png" >}} |
| 48 | +</span> |
| 49 | + |
| 50 | +- **Instance availability** |
| 51 | + Understand the operational state of each instance. |
| 52 | + - **Online**: Agent and NGINX are connected and working. |
| 53 | + - **Offline**: Agent is running but NGINX isn’t installed, isn’t running, or can’t talk to the agent. |
| 54 | + - **Unavailable**: Agent lost connection or instance was removed. |
| 55 | + - **Unknown**: Current state can’t be determined. |
| 56 | + |
| 57 | +- **NGINX versions by instance** |
| 58 | + See which NGINX OSS or Plus versions your instances are running. |
| 59 | + |
| 60 | +- **Operating systems** |
| 61 | + Find out which Linux distributions are in use. |
| 62 | + |
| 63 | +- **Certificates** |
| 64 | + Monitor your SSL certificates—expiring soon or still valid. |
| 65 | + |
| 66 | +- **Config recommendations** |
| 67 | + Get actionable suggestions to improve security, performance, and best practices. |
| 68 | + |
| 69 | +- **CVEs (Common Vulnerabilities and Exposures)** |
| 70 | + Evaluate threats by severity. |
| 71 | + - **Major**: High-severity; fix immediately. |
| 72 | + - **Medium**: Moderate-severity; plan a fix soon. |
| 73 | + - **Low/Minor**: Lower-severity; monitor. |
| 74 | + - **Other**: Any non-standard categories. |
| 75 | + |
| 76 | +- **CPU utilization** |
| 77 | + Track which instances are using the most CPU over time. |
| 78 | + |
| 79 | +- **Memory utilization** |
| 80 | + Watch which instances consume the most RAM over time. |
| 81 | + |
| 82 | +- **Disk space utilization** |
| 83 | + See which instances are nearing full disk capacity. |
| 84 | + |
| 85 | +- **Unsuccessful response codes** |
| 86 | + Spot instances with high counts of HTTP 4xx/5xx errors. |
| 87 | + |
| 88 | +- **Top network usage** |
| 89 | + Review network throughput (in/out) trends for your instances. |
| 90 | + |
| 91 | +--- |
| 92 | + |
| 93 | +## 2. Investigate CVEs |
| 94 | + |
| 95 | +Use the **CVEs** panel to investigate vulnerabilities in your instances: |
| 96 | + |
| 97 | +1. In the **CVEs** panel, select **High** to list instances with high-severity issues. |
| 98 | +2. Select your `$NAME-plus1` instance to view its CVE details, including ID, severity, and description. |
| 99 | +3. Select any CVE ID (for example, `CVE-2024-39792`) to open its official page with full details and remediation guidance. |
| 100 | +4. Switch to the **Security** tab to see every CVE NGINX One tracks, along with how many instances each affects. |
| 101 | +5. Select **View More** next to a CVE name for a direct link to the CVE database. |
| 102 | + |
| 103 | +--- |
| 104 | + |
| 105 | +## 3. Investigate certificates |
| 106 | + |
| 107 | +The **Certificates** panel shows the total number of certificates and their status distribution across all instances. |
| 108 | + |
| 109 | +The statuses mean: |
| 110 | + |
| 111 | +- **Expired**: The certificate’s expiration date is past. |
| 112 | +- **Expiring**: The certificate will expire within 30 days. |
| 113 | +- **Valid**: The certificate is not near expiration. |
| 114 | +- **Not Ready**: NGINX One can’t determine this certificate’s status. |
| 115 | + |
| 116 | +> **Note:** NGINX One only scans certificates that are part of a running NGINX configuration. |
| 117 | +
|
| 118 | +1. In the **Certificates** panel, select **Expiring** to list certificates that will expire soon. |
| 119 | +2. Select your `$NAME-oss1` instance and switch to the **Unmanaged** tab to see each certificate’s name, status, expiration date, and subject. |
| 120 | +3. Select a certificate name (for example, `30-day.crt`) to open its details page. |
| 121 | +4. Scroll to **Placements** to see all instances that use that certificate. |
| 122 | + |
| 123 | +--- |
| 124 | + |
| 125 | +## 4. Configuration recommendations |
| 126 | + |
| 127 | +Recommendations are color-coded: |
| 128 | + |
| 129 | +- **Orange** = Security |
| 130 | +- **Green** = Optimization |
| 131 | +- **Blue** = Best practices |
| 132 | + |
| 133 | +1. On **Overview > Config Recommendations**, Select **Security** then select `$NAME-oss1`. |
| 134 | +2. Switch to the **Configuration** tab. Files with issues show colored badges. |
| 135 | +3. Select a file (for example, `cafe.example.com.conf`) to view recommendations with line numbers. |
| 136 | +4. Use the **Edit** (pencil) icon to enter edit mode. |
| 137 | +5. Fix issues or apply best practices. Select **Next** to see a diff, then **Publish** to apply changes. |
| 138 | + |
| 139 | +--- |
| 140 | + |
| 141 | +## 5. AI Assistant |
| 142 | + |
| 143 | +Highlight any config text (directive, variable, or phrase) and Select **Explain with AI**. The AI will provide: |
| 144 | + |
| 145 | +- Definitions of directives and variables |
| 146 | +- Best-practice tips |
| 147 | +- Use-case guidance |
| 148 | + |
| 149 | +Try it on: |
| 150 | + |
| 151 | +- `stub_status` |
| 152 | +- `proxy_buffering off` |
| 153 | +- `$upstream_response_time` |
| 154 | + |
| 155 | +> **Pro tip:** Use AI to explore logging variables or other obscure directives without leaving the Console. |
| 156 | +
|
| 157 | +--- |
| 158 | + |
| 159 | +## Next steps |
| 160 | + |
| 161 | +When you’re ready, move on to [Lab 4 →](../lab4/readme.md) |
| 162 | + |
| 163 | +--- |
| 164 | + |
| 165 | +## References |
| 166 | + |
| 167 | +- [NGINX One Console docs](https://docs.nginx.com/nginx-one/) |
0 commit comments