Skip to main content
Version: 4.x

Workbench

Overview

After logging in you land on the Workbench. It consists of system announcements, quick navigation links and a to-do list, and is meant to share information with the team and collect frequently used entry points. The Dashboard shows the overall state of the platform in charts.

Workbench

Announcements

Administrators click Edit in the card header to create, modify or delete announcements.

  • Title / Content: multi-line text is supported.
  • Popup reminder: when enabled, the announcement pops up for every user on login; only one announcement can be a popup.

Quick navigation

Collect links the team uses every day, such as monitoring dashboards, code repositories or the wiki. Administrators click Edit and then New:

  • Icon: an image smaller than 100 KB, stored directly in the database.
  • Title / Description: shown on the card.
  • Links: one card can hold several links (three at most is recommended), for example the test and production instance of the same system.

To-do

Items that need your attention, such as deploy requests waiting for review. Click an item to jump straight to it.

Dashboard

The Dashboard counts applications, hosts, tasks and monitors and shows two charts: Alert trend (filterable by monitor) and Top 20 deploy requests (today / this week / this month). Regular users need the Dashboard permission in their role.

Dashboard

From left to right the icons in the top-right corner are:

  • Notifications: deploy reviews, failed scheduled tasks, failed alert deliveries and other system events are shown as in-app notifications; read notifications older than a week are removed automatically.
  • Web terminal: opens the web terminal in a new window.
  • Language: switch between English and Simplified Chinese; the choice is stored in the browser.
  • Profile: change your name, set your WeChat token, change your password, or Log out.

Profile