isabella232 / sensu-alpha-documentation

Sensu 2.0 Alpha Documentation and Examples

About Sensu Alpha Documentation

Welcome friends 👋! This repository is intended primarily for Sensu 2.0 Alpha users to guide them through their initial use. The Alpha Program is a small, high-touch collaboration with Sensu Inc's engineering team as they produce a Beta ready for wider use. We appreciate everyone's patience in this early stage. For regular updates, join our Community Slack or our mailing list.

If you are not already a Sensu 2.0 Alpha Program participant, visit sensuapp.org/alpha to apply!

Alpha Program Goals

Our hope is that Sensu 2.0 Alpha users will follow along with the documentation and attempt to experiment with the functionality that we currently have available. Beyond that, we would love further experimentation with those features you are particularly interested in. For some examples:

If you have multiple environments, you may like to dig a little deeper into our RBAC functionality. Or if you are interested in distributed checks without configuration management, you might take a closer look at Checks and Assets.

We hope that throughout the alpha program we can:

• Test early Sensu 2.0 prereleases in diverse, real world situations.

• Collect feedback from existing and new Sensu users to help ensure we are taking Sensu in the right direction.

• Produce experienced Sensu 2.0 prerelease users before the Sensu 2.0 beta (Q1 of 2018).

Overview

Sensu 2.0 is a complete rewrite of Sensu in Go. It can be installed via a binary distribution, packages, or used in Docker containers (see the installation instructions for further details). There are three components to Sensu 2.0: the sensu-backend, sensu-agent, and sensuctl programs.

sensu-backend

The sensu-backend program replaces sensu-server and sensu-api. It will also replace the sensu-enterprise-dashboard or uchiwa programs in the future. It is responsible for the Sensu 2.0 API and Transport.

sensu-agent

The sensu-agent program replaces sensu-client.

sensuctl

The first UI we've implemented for Sensu 2.0 is the CLI sensuctl. See the CLI section for more information.

More Documentation

1. What's different? - What's different in Sensu 2.0?
2. Installation - Installing and Configuring Sensu 2.0
3. CLI An overview of the Sensu CLI utility - sensuctl
4. RBAC - An overview of Sensu RBAC and Multitenancy
5. Users - Creating and managing users and roles
6. Checks - Creating and managing checks and assets
7. Events - An overview of events in Sensu
8. Hooks - Creating and managing hooks (with checks, mutators, and handlers)
9. Silencing - An overview of Silencing checks, subscriptions, and entities
10. Getting Help - How to get help with Sensu 2.0
11. Upgrading - How to upgrade the Sensu Alpha
12. CHANGELOG - What changed between Sensu Alpha releases