Adding add-ons in the form

Status: Implemented Issue: none Parent: GitLab instance form

Goal

An administrator sees only the add-ons an instance has in the Bridge form, and adds another one from a dialog, together with the add-ons it needs, instead of scanning every add-on there is.

Requirements

  • The sidebar lists each add-on by its title only. A new instance has none, and the Add-ons group says so.
  • An edited instance lists the add-ons it has, and no other: Secret Manager, Container Registry, or Toolbox when spec.components has its entry, on or off, and Siphon or Orbit when its resource exists or cannot be read. Until the instance has loaded, the group offers no +.
  • A + button beside Add-ons opens a dialog that lists every add-on, with what it does and what it needs. An add-on already listed is marked Added, one not built yet Soon, and neither can be chosen.
  • The dialog closes on Escape, on its close button, and on a click outside it, also after a click on its text. Focus then returns to +. While the dialog is open, Tab stays inside it.
  • Choosing an add-on closes the dialog, lists the add-on, switches it on, and opens it. It shows unsaved changes until the form is saved.
  • Choosing an add-on that needs another adds both and switches both on. Orbit needs Siphon, and its entry says so, and that Siphon is added with it while Siphon is not listed. While the Siphon cannot be read, an added Orbit stays off and locked, as the Orbit add-on defines.
  • Switching an add-on off keeps it listed until the page is left. Saving it off does what GitLab components, the instance form, and the Orbit add-on define.
  • An add-on that is not listed is not validated and not sent.

Out of scope

  • Removing an add-on from the sidebar without leaving the page.
  • Dependencies between add-ons other than Orbit on Siphon.

FAQ

  • Why does adding Orbit switch on a Siphon that was switched off? Orbit fails validation without one, so adding Orbit states that the instance needs both.
  • Why does an add-on switched off stay listed? Saving it off still writes something: a deletion, or an entry that keeps its settings. The add-on has to stay reachable to switch it back on before the save.
  • Why is an entry switched off still shown on load? It keeps settings that switching it back on restores.
  • Why does the sidebar not say whether an add-on is on? Nearly every listed add-on is on, so a status beside each one repeated the same word. The section of the add-on already shows it.