generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 89
feat: NGINX One Console use-case based home page #595
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
6c54e0c
Draft: new N1C doc homepage
mjang 48bdbdb
Less
mjang 625d88c
More
mjang 762b1d1
update
mjang 4fa781a
new messages
mjang ad9f51e
Sync with presentation
mjang 4c1ca64
Make more prod ready
mjang 375110b
Make more prod ready
mjang 2fdf3dd
More
mjang 2f0e810
more
mjang 8d3f6db
based on Jason's feedback
mjang cab3ac1
more
mjang 7e2af00
typo
mjang 7d2d74d
More
mjang 88cd0fe
typo
mjang 458f66c
Add redirects
mjang 671b267
reorg May 28, part 1
mjang 76dd38f
more edits, may 28
mjang e66cdd9
May 28 updates part 3
mjang 1d899c5
typos
mjang c7f99dd
reorder sections
mjang 6defad9
Apply suggestions from code review
mjang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
docs: | ||
files: | ||
- content/nginx-one/nginx-configs/add-instance.md | ||
- content/nginx-one/getting-started.md | ||
--- | ||
<!-- Note: I still want to set this up in getting-started.md. (has not happened yet) --> | ||
|
||
mjang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
You can add an instance to NGINX One Console in the following ways: | ||
|
||
- Directly, under **Instances** | ||
- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group** | ||
|
||
In either case, NGINX One Console gives you a choice for data plane keys: | ||
|
||
- Create a new key | ||
- Use an existing key | ||
|
||
NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console. | ||
|
||
Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< ref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host. | ||
|
||
```bash | ||
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y | ||
``` | ||
|
||
Once the process is complete, you can configure that instance in your NGINX One Console. |
39 changes: 39 additions & 0 deletions
39
content/includes/use-cases/monitoring/n1c-dashboard-overview.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
docs: | ||
files: | ||
- content/nginx-one/metrics/enable-metrics.md | ||
- content/nginx-one/getting-started.md | ||
--- | ||
|
||
Navigating the dashboard: | ||
|
||
- **Drill down into specifics**: For in-depth information on a specific metric, like expiring certificates, select the relevant link in the metric's card to go to a detailed overview page. | ||
- **Refine metric timeframe**: Metrics show the last hour's data by default. To view data from a different period, select the time interval you want from the menu. | ||
|
||
<span style="display: inline-block; margin-top: 20px; margin-bottom: 50px;"> | ||
{{< img src="nginx-one/images/nginx-one-dashboard.png">}} | ||
</span> | ||
|
||
{{<bootstrap-table "table table-striped table-bordered">}} | ||
**NGINX One dashboard metrics** | ||
| Metric | Description | Details | | ||
|---|---|---| | ||
| <i class="fas fa-heartbeat"></i> **Instance availability** | Understand the operational status of your NGINX instances. | - **Online**: The NGINX instance is actively connected and functioning properly. <br> - **Offline**: NGINX Agent is connected but the NGINX instance isn't running, isn't installed, or can't communicate with NGINX Agent. <br> - **Unavailable**: The connection between NGINX Agent and NGINX One has been lost or the instance has been decommissioned. <br> - **Unknown**: The current state can't be determined at the moment. | | ||
| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | | | ||
| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | | | ||
| <i class="fas fa-certificate"></i> **Certificates** | Monitor the status of your SSL certificates to know which are expiring soon and which are still valid. | | | ||
| <i class="fas fa-cogs"></i> **Config recommendations** | Get configuration recommendations to optimize your instances' settings. | | | ||
| <i class="fas fa-shield-alt"></i> **CVEs (Common Vulnerabilities and Exposures)** | Evaluate the severity and number of potential security threats in your instances. | - **Major**: Indicates a high-severity threat that needs immediate attention. <br> - **Medium**: Implies a moderate threat level. <br> - **Minor** and **Low**: Represent less critical issues that still require monitoring. <br> - **Other**: Encompasses any threats that don't fit the standard categories. | | ||
| <i class="fas fa-microchip"></i> **CPU utilization** | Track CPU usage trends and pinpoint instances with high CPU demand. | | | ||
| <i class="fas fa-memory"></i> **Memory utilization** | Watch memory usage patterns to identify instances using significant memory. | | | ||
| <i class="fas fa-hdd"></i> **Disk space utilization** | Monitor how much disk space your instances are using and identify those nearing capacity. | | | ||
| <i class="fas fa-exclamation-triangle"></i> **Unsuccessful response codes** | Look for instances with a high number of HTTP server errors and investigate their error codes. | | | ||
| <i class="fas fa-tachometer-alt"></i> **Top network usage** | Review the network usage and bandwidth consumption of your instances. | | | ||
|
||
{{</bootstrap-table>}} | ||
|
||
|
||
|
||
|
||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: API | ||
title: Automate with the NGINX One API | ||
mjang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
description: | ||
weight: 1000 | ||
weight: 700 | ||
url: /nginx-one/api | ||
--- | ||
--- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
description: | ||
title: Connect your instances to the console | ||
weight: 200 | ||
url: /nginx-one/connect-instances/ | ||
--- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
description: | ||
title: Connect your containers | ||
weight: 300 | ||
url: /nginx-one/connect-instances/containers | ||
--- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
content/nginx-one/connect-instances/data-plane-keys/_index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
description: | ||
title: Set up data plane keys | ||
weight: 100 | ||
url: /nginx-one/connect-instances/data-plane-keys | ||
--- |
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.