luis-sousa-pinto / sensu-web

Open-source Web UI for Sensu Go clusters

Sensu Go Web

A web interface for insight and management of your Sensu Go clusters.

Roadmap

As of version 6.0, the official Sensu web app has moved to the commercial product codebase. Users who want an officially supported web app for use with Sensu Go should try the commercial distribution available at https://sensu.io/downloads

Users who download and compile Sensu Go from source and want a web UI will need to download and run this web app as a separate component (see INSTALL.md). Please note that the web interface included in the commercial distribution no longer shares a common codebase with this project. For more details regarding these changes, please see Building a better UI for Sensu.

Goals

The primary goal of this project was to offer a simple web interface that provides visibility into Sensu Go's "stateful" data (e.g., real-time invetory and real-time event dashboards). At this time, this includes the following:

• Basic auth (login using Sensu Go user credentials)
• Namespace switching
• Views reflecting event, entity, and silence state. (Scoped by namespace.)

Non-Goals

This project does not aim to provide a web-based interface for every feature of the open-source Sensu Go platform, specifically including the configuration of Sensu Go pipelines. As a result, certain features of this project may break with new releases of Sensu Go. The Sensu Engineering team will review and merge PRs submitted by the community, and/or periodically publish new releases to mark certain features as "deprecated" (or just remove them).

NOTE: although "PRs are always welcome" (!), any PR which implements features that are non-goals of this project may be closed as "won't fix". Furthermore, any issues and/or PRs proposing enhancements that are already implemented -OR- that are on our roadmap for the commercial distribution may also be closed as "won't fix"; conversely, we may from time to time choose to port features from the commercial distribution into this project.

This project will maintain its permissive MIT license, and may be used as a baseline for new Sensu Go web interface projects and/or forks of this project.

Getting Started

To start the UI, simply run the following:

yarn install
NODE_ENV=production PORT=80 API_URL=https://my-sensu-backend-api:8080 yarn node scripts serve

For more detailed installation instructions, see INSTALL.md

Contributing

Sensu is and always will be open source, and we continue to highly value community contributions. For guidelines on how to contribute to this project, how to hack on Sensu, and information about what we require from project contributors, please see CONTRIBUTING.md.