Screwdriver: feature: There is no way to announce the downtime.

Created on 2 Apr 2018  路  2Comments  路  Source: screwdriver-cd/screwdriver

What happened:
It is useful if users are able to know about the downtime from web ui. We'd like to show the message like 2018/4/2 10:00 - 11:00 : Screwdrivrer will down for maintenance at top of pages.

What you expected to happen:
Screwdriver UI can show maintenance message.

feature

Most helpful comment

This feature is available now. SD admins can create and delete banners to be displayed in UI.

Example:
screen shot 2018-05-16 at 5 50 16 pm

Blog post: http://blog.screwdriver.cd/post/174026600097/screwdriver-banners
Documentation: https://docs.screwdriver.cd/cluster-management/FAQ#how-do-i-post-announcements-on-the-ui

All 2 comments

Proposal

We should add endpoints to update and delete banner messages in the Screwdriver UI. Remove, create, and update should require admin permissions (https://github.com/screwdriver-cd/screwdriver/blob/master/config/default.yaml#L31).

  1. __POST__ /banners
    __body__: { message: <STRING> }
  2. __PUT__ /banners/{id}
    __body__: { message: <STRING> }
  3. __GET__ /banners/{id}
  4. __GET__ /banners to list all banners
  5. __DELETE__ /banners/{id}

Tasks

  • [x] data-schema: Add a banner table and schema validation (somewhere here https://github.com/screwdriver-cd/data-schema/tree/master/models)
  • [x] models: Add banner model (should be very similar to https://github.com/screwdriver-cd/models/blob/master/lib/collectionFactory.js, https://github.com/screwdriver-cd/models/blob/master/lib/collection.js)
  • [x] API:

    • [x] Take in auth admin information

    • [x] Add endpoints in a banners folder (see https://github.com/screwdriver-cd/screwdriver/tree/master/plugins) with banners README.md

  • [x] UI: Display banner on UI

Changelog

  • 5/2/18 - updated endpoints

This feature is available now. SD admins can create and delete banners to be displayed in UI.

Example:
screen shot 2018-05-16 at 5 50 16 pm

Blog post: http://blog.screwdriver.cd/post/174026600097/screwdriver-banners
Documentation: https://docs.screwdriver.cd/cluster-management/FAQ#how-do-i-post-announcements-on-the-ui

Was this page helpful?
0 / 5 - 0 ratings