HOWTO.md

Status

Provide Nuclia current status + feature flagging

Purpose

This repository allows to broadcast important warning and/or info messages to all dashboard users. Messages are shown at loading time, and only once.

Other purposes:

• Feature flagging: it stores the list of features when want to hide/show on prod.
• Desktop connectors: it stores some pluggable connectors for Desktop app.

Usage

Alert message

• Edit status.json
• Increment the index (the last message index is stored in the dashboard, so once displayed, it does not appear again unless the index is higher)
• Put the relevant message
• Set active to true
• Commit the file
• Modify index.html to write a message that can be read on the Status page (to make it easier, we can just comment the existing paragraph and uncomment the other one)

Note: GitHub files have a 10 minutes cache, so users who opened the dashboard less than 10 minutes before the message update will not see the warning.

When the problem is gone, edit again status.json and set active to false, and restore the original message on index.html

Info message

• Edit announce.json
• Increment the index
• Put the relevant message (possibly in HTML)
• Set active to true
• Commit the file

Feature flagging

• Edit features.json
• Set the features you want, value can be true, false, or a string
• Commit the file

Feature flagging V2

• Edit features-v2.json
• Set the features you want, the value is a json object that contains:
  • Rollout: Integer from 0 to 100 (0 -> disabled, 100 -> enabled)
  • Variants (Optional). When using variants the rollout value should be set to 0. Using multiple variants act as an OR condition.
    • Example one variant: {"environment:": ["stage", "test"]}. Flag enabled when environment is stage or test.
    • Example two variants: {"environment:": ["stage"], "zone": ["europe"]}. Flag enabled when environment is stage or zone is europe.
• Commit the file