Project-FiFo

The Project-FiFo Developer Hub

Welcome to the Project-FiFo developer hub. You'll find comprehensive guides and documentation to help you start working with Project-FiFo as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

This document will cover the basics of Cerberus, login, general workflows and UX logic. It will not dive into the details of each sub page.

Login

login page

login page

The login page offers three inputs:

  • Login - The username to log in with
  • Password - The password to the username
  • YubiKey - If MFA is used then this is where the YubiKey goes, if it is not used it can be left blank.

Listing

list view

list view

The listing is the central view of Cerberus, from here all further screens can be reached and most actions can be taken. The layout stays the same throughout every list page.

  1. The menu from which to navigate to other pages
  2. The element being listed
  3. The table of listed elements, the fields are sortable
  4. The column selector
  5. The search field, allowing for custom search syntax (see below)
  6. The actions button, to perform actions on an element of the list
  7. The create button, it is context sensitive and will allow adding elements 'of the current type' so when listing machines the button adds a new machine.

Search syntax

When simply typing text into the search box it will look though the fields and only show elements where at least one field matches.

However it is possible to refine the search. For once it is possible to restrict which field is looked at, by prefixing the search item with a <field>: for example name:fifo will look for 'fifo' in the name field. Then it is possible to query for more then 'includes' by using different comparison operators after the colon:

  • = must exactly equal
  • ~ treats the search term as a regular expression
  • > and >= means the field has to be larger or larger and equal then the value, the search value will be treated as an integer.
  • < and <= means the field has to be larger or larger and equal then the value, the search value will be treated as an integer.

If multiple field matches are used then they are treed as a logical 'and' so the query: ram:>1024 ram:<=2048 will show all vm's that have more then 1 gigabyte but at most two gigabytes of ram assigned.

Create

When the create button is pressed a pane is shown on the button to allow inputting the required information.

create view

create view

  1. Information about the item to be created
  2. Allows minimizing and maximizing the create view to keep working with the UI during the create process
  3. Cancels the create process
  4. Sends the create request

Notifications

When actions are preformed in the UI success or failure notifications are given. This notifications are shown in two ways.

notification overlay

notification overlay

Directly after the action is finished a overlay is shown for a short time to give direct feedback.

notification menu

notification menu

At the very top right there is a notification menu which keeps notifications for a while longer. Success and warning notifications will still time out after a longer while but failure notifications are kept until acknowledged (clicked on) to allow tracking issues.