Skip to main content

Working in a Builder

Builder is the interactive heart of the platform, where you visually design, configure, and monitor your application architectures in real-time.

More details about the Builder can be found in Builder Module Documentation.

Builder Parts

Builder is divided into four main parts:

  • Left Sidebar: Contains tools for adding qubes, as well as options for managing your workspace.
  • Canvas: Visual area where you design and configure your application architecture by adding qubes and connectors.
  • Footer: Show logs and metrics related to your workspace.
  • Right Sidebar: Contains properties and settings for selected qubes and connectors.

Main Actions

Adding Qubes

  1. Open the left sidebar by clicking the Qubes tab.
  2. Browse or search for the desired qube.
  3. Click Plus button next to the qube to add it to the canvas.

Removing Qubes

  1. Select the qube on the canvas by clicking on it.
  2. Click the Settings icon in the right sidebar and than click Remove Qube to remove the qube from the canvas.

Connecting and Disconnecting Qubes

  1. Add all desired qubes to the canvas.
  2. Click the Connectors tab in the right sidebar.
  3. Select the desired connector between the qubes.
  4. Click already selected connector to remove the connection.

Configuring Qubes

  1. Select the qube on the canvas by clicking on it.
  2. Use the right sidebar to modify properties and settings of the selected qube.

Deploying and Destroying Workspace

  1. Click the Instantiate button in the Canvas header.
  2. Workspace will start deploying. You can monitor the progress in the footer logs.
  3. To destroy the workspace, click the Destroy button in the Canvas header.

Saving Workspace

  1. Once you have made changes to your workspace in the builder, changed fields will be highlighted with a yellow border.
  2. Click the Sync button in the Canvas header to save the current state of your workspace.