-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sensu Enterprise Dashboard docs and changelog (#148)
* changed links for 2.10 and rbac links * Adding 2.9 and 2.11 Sensu-Enterprise-Dashboard * Added Sensu-Enterprise-Dashboard 2.11 and 2.9 to config.toml * sensu-enterprise-dashboard 2.11 changelog Copy/Pasta of the main changelog. * sensu-enterprise-dashboard 2.10 changelog copy pasta of 2.11 with 2.11 parts removed * Sensu-enterprise-dashboard 2.9 changelog copy pasta of 2.10 with 2.10 removed. also removed the uchiwa links not required for 2.10 * Fixed version for 2.9 and 2.10 * Fixed link for static image under HUD * Renamed titles for Configuration and Dashboard Changed "sensu dashboard configuration" to "configuration" Changed "sensu dashboard" title to "overview"
- Loading branch information
1 parent
2a579c7
commit 97c5389
Showing
32 changed files
with
6,953 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains 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
2 changes: 1 addition & 1 deletion
2
...su-enterprise-dashboard/2.10/dahsboard.md → ...su-enterprise-dashboard/2.10/dashboard.md
This file contains 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,5 +1,5 @@ | ||
--- | ||
title: "Sensu Dashboard" | ||
title: "Overview" | ||
product: "Sensu Enterprise Dashboard" | ||
version: "2.10" | ||
weight: 1 | ||
|
This file contains 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 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,83 @@ | ||
--- | ||
title: "Sensu Enterprise Dashboard" | ||
product: "Sensu Enterprise Dashboard" | ||
version: "2.11" | ||
weight: 0 | ||
menu: "sensu-enterprise-dashboard-2.11" | ||
layout: "single" | ||
--- | ||
|
||
## Reference Documentation | ||
|
||
- [What is the Sensu Enterprise Dashboard?](#what-is-the-sensu-enterprise-dashboard) | ||
- [What is Uchiwa?](#what-is-uchiwa) | ||
- [What is the Sensu Enterprise Console?](#what-is-the-sensu-enterprise-console) | ||
- [What is a Sensu "datacenter"?](#what-is-a-sensu-datacenter) | ||
|
||
|
||
## What is the Sensu Enterprise Dashboard? | ||
|
||
The Sensu Enterprise Dashboard is a simple web-based application that provides | ||
realtime visibility into Sensu monitoring data, with dedicated views for | ||
monitoring events, clients, checks, aggregates, data centers, and more. The | ||
dashboard provides powerful global search features for filtering views so users | ||
can focus on the data that's important to them. The dashboard also provides | ||
basic operational controls to acknowledge or otherwise "silence" monitoring | ||
events, request ad hoc execution of monitoring checks, and much more. | ||
|
||
### What is Uchiwa? | ||
|
||
The Sensu Enterprise Dashboard is based on the open-source – and | ||
community developed – [Uchiwa][2] dashboard. Very much like the | ||
relationship between Sensu Core and Sensu Enterprise, the Sensu Enterprise | ||
Dashboard builds on top of Uchiwa via a number of added-value extensions (e.g. | ||
[Role Based Access Controls][3]; [LDAP][4], [GitHub][5], and [GitLab][6] | ||
authentication; [Audit Logging][7]; etc), which development also results in | ||
many contributions to the open-source Uchiwa dashboard project. | ||
|
||
### What is the Sensu Enterprise Console? | ||
|
||
The Sensu Enterprise Console is a federated API endpoint provided by the Sensu | ||
Enterprise Dashboard for API access to multiple [Sensu datacenters][1] | ||
(available in Sensu Enterprise Dashboard version 1.10 and newer). This API | ||
provides added-value features including token-based authentication and [granular | ||
role-based access controls][16]. | ||
|
||
_NOTE: the Sensu Enterprise Dashboard is comprised of two components: a backend | ||
service (API) for aggregating monitoring data from one or more [Sensu | ||
datacenters][5], and a web application for displaying this information. As of | ||
Sensu Enterprise Dashboard version 1.10, this Sensu Enterprise Dashboard backend | ||
has been updated so that it provides the same API endpoints as the [Sensu | ||
API][1]. Prior to version 1.10, the Sensu Enterprise Dashboard backend used | ||
different API routes for accessing data from specific datacenters; for example, | ||
client data was accessible via `/clients/us-west-1/:client` instead of | ||
`/clients/:client?dc=us-west-1`. Version 1.11 introduced access token-based | ||
authentication, and version 1.12 introduced RBAC for the Console API._ | ||
|
||
## What is a Sensu "datacenter"? | ||
|
||
The Sensu Enterprise Dashboard provides access to monitoring data from one or | ||
more Sensu "datacenters". A Sensu datacenter is simply a Sensu API endpoint, | ||
which corresponds to a Sensu installation consisting of one or more Sensu | ||
servers in cluster (multiple API endpoints may be provided by a single Sensu | ||
installation or cluster). | ||
|
||
|
||
[1]: #what-is-a-sensu-datacenter | ||
[2]: http://www.uchiwa.io | ||
[3]: /sensu-enterprise-dashboard/2.11/rbac/overview | ||
[4]: /sensu-enterprise-dashboard/2.11/rbac/rbac-for-ldap | ||
[5]: /sensu-enterprise-dashboard/2.11/rbac/rbac-for-github | ||
[6]: /sensu-enterprise-dashboard/2.11/rbac/rbac-for-gitlab | ||
[7]: /sensu-enterprise-dashboard/2.11/rbac/audit-logging | ||
[8]: #dashboard-definition-specification | ||
[9]: /sensu-core/1.2/reference/configuration#configuration-scopes | ||
[10]: /sensu-core/1.2/reference/configuration#configuration-merging | ||
[11]: #auth-attributes | ||
[12]: #audit-attributes | ||
[13]: #ldap-attributes | ||
[14]: #github-attributes | ||
[15]: #gitlab-attributes | ||
[16]: /sensu-enterprise-dashboard/2.11/rbac/overview#rbac-for-the-sensu-enterprise-console-api | ||
[17]: /sensu-enterprise-dashboard/2.11/rbac/rbac-for-oidc | ||
[18]: #oidc-attributes |
Oops, something went wrong.