Skip to content

Commit

Permalink
Sensu Enterprise Dashboard docs and changelog (#148)
Browse files Browse the repository at this point in the history
* 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
Edgar Valdes authored and cwjohnston committed Jan 30, 2018
1 parent 2a579c7 commit 97c5389
Show file tree
Hide file tree
Showing 32 changed files with 6,953 additions and 13 deletions.
5 changes: 4 additions & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,12 @@ pygmentsUseClasses=true
name = "Sensu Enterprise Dashboard"
description = "The dashboard is quite fancy and super helpful."
weight = 3
latest = "2.10"
latest = "2.11"
[params.products.sensu_enterprise_dashboard.versions]
"2.11" = ["Ubuntu/Debian", "RHEL/CentOS"]
"2.10" = ["Ubuntu/Debian", "RHEL/CentOS"]
"2.9" = ["Ubuntu/Debian", "RHEL/CentOS"]


[params.products.uchiwa]
identifier = "uchiwa"
Expand Down
18 changes: 9 additions & 9 deletions content/sensu-enterprise-dashboard/2.10/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,19 @@ installation or cluster).

[1]: #what-is-a-sensu-datacenter
[2]: http://www.uchiwa.io
[3]: /sensu-enterprise-dashboard/rbac/overview
[4]: /sensu-enterprise-dashboard/rbac/rbac-for-ldap
[5]: /sensu-enterprise-dashboard/rbac/rbac-for-github
[6]: /sensu-enterprise-dashboard/rbac/rbac-for-gitlab
[7]: /sensu-enterprise-dashboard/rbac/audit-logging
[3]: /sensu-enterprise-dashboard/2.10/rbac/overview
[4]: /sensu-enterprise-dashboard/2.10/rbac/rbac-for-ldap
[5]: /sensu-enterprise-dashboard/2.10/rbac/rbac-for-github
[6]: /sensu-enterprise-dashboard/2.10/rbac/rbac-for-gitlab
[7]: /sensu-enterprise-dashboard/2.10/rbac/audit-logging
[8]: #dashboard-definition-specification
[9]: /sensu-core/1.0/reference/configuration#configuration-scopes
[10]: /sensu-core/1.0/reference/configuration#configuration-merging
[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]: ../rbac/overview#rbac-for-the-sensu-enterprise-console-api
[17]: ../rbac/rbac-for-oidc
[16]: /sensu-enterprise-dashboard/2.10/rbac/overview#rbac-for-the-sensu-enterprise-console-api
[17]: /sensu-enterprise-dashboard/2.10/rbac/rbac-for-oidc
[18]: #oidc-attributes
600 changes: 600 additions & 0 deletions content/sensu-enterprise-dashboard/2.10/changelog.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion content/sensu-enterprise-dashboard/2.10/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Sensu Dashboard Configuration"
title: "Configuration"
product: "Sensu Enterprise Dashboard"
version: "2.10"
weight: 2
Expand Down
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
Expand Down
2 changes: 1 addition & 1 deletion content/sensu-enterprise-dashboard/2.10/hud.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ As of version 1.3, a new Heads Up Display (HUD) has been added to the Sensu
Enterprise Dashboard, which provides an at-a-glance view into the overall health
of your infrastructure via a set of built-in graphs and status widgets.

![heads-up display screenshot](/static/images/enterprise-dashboard-hud.png)
![heads-up display screenshot](/images/enterprise-dashboard-hud.png)

## HUD RBAC Support

Expand Down
83 changes: 83 additions & 0 deletions content/sensu-enterprise-dashboard/2.11/_index.md
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

0 comments on commit 97c5389

Please sign in to comment.