Skip to main content

Builder

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

The Builder is a powerful visual interface where you bring your application stacks to life. It provides a drag-and-drop canvas for adding applications, connecting them, and modifying their configurations. This tool is designed to give you a complete, holistic view of your workspace, from high-level architecture down to real-time application logs.

Builder Parts

Builder is divided into four main parts:

  • Left Sidebar:
    • Project:
      • Information about current project and workspace
      • You can see all relevant cluster information
      • Ability to switch workspaces inside the same project
      • Workspace actions (3 vertical dots)
    • Catalog:
      • List of applications you can add to your workspace
      • Add app to your workspace by clicking plus icon
      • Get more info on the app by clicking info icon
  • Canvas:
    • Graphical area where you build your application stack by adding qubes and connectors
    • Drag and drop qubes to rearrange them
    • Click on qubes/connectors to select and configure them
    • Main action buttons (Instantiate, Destroy, Sync)
  • Footer:
    • Displays real-time logs during deployment and destruction of the workspace
    • Shows status messages and errors
    • Shows current workspace metrics and resource usage
  • Right Sidebar:
    • Parameters:
      • Change properties and settings of selected qube or connector
      • Show qube data
      • When deployed, view IP addresses, URLs, status, and other runtime info
    • Connectors:
      • List of available connectors between qubes
      • Add or remove connections by clicking on them

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.

Other Features

Workspace Operations

Workspace operations can be accessed by clicking the Settings icon in the Canvas header. Here you can perform various actions such as:

  • Clear
  • Copy
  • Paste
  • Export
  • Import