Brainboard's documentation
Go to the app ↗
  • Welcome
  • Getting started
    • Fast track
    • Start with a template
    • Start with AI
    • Use cases videos
    • Brainboard philosophy
  • Cloud design
    • Left bar
      • Cloud resources
      • Input & output
    • Design area
      • Node
      • ID card
      • Connectors
      • Versioning
      • Graphical options
    • One action
    • Code Edition
  • Data
    • Data structure
      • Project
      • Environment
      • Cloud architecture
        • Terraform files
        • Readme file
        • Architecture Synchronization
        • Remote backend
      • Template
    • Cloud providers
      • Supported cloud providers
      • Customize provider configuration
      • Unsupported cloud providers
    • Terraform / OpenTofu
      • Modules
        • Module
        • Import modules
        • Manage module
        • Terraform registry credentials
        • Use modules
    • Disaster recovery
  • Automation
    • CI/CD engine
    • Supported plugins
      • Terraform
      • Security
        • Trivy
        • Tfsec
        • Terrascan
        • OPA
        • Checkov
      • Infracost
      • Notifications
        • Email
        • Slack
        • Microsoft Teams
      • Webhooks
    • Pipelines
    • Workflow templates
    • Drift detection
      • Types of drift
      • Remediation
    • Self-Hosted Runner
      • Deploy runner with Kubernetes
      • Deploy runner with docker-compose
  • Settings
    • Overview
    • Authentication
      • Login into Brainboard
      • Single sign-on (SSO)
    • Account management
    • Organization
    • Members
    • Teams
    • Roles & Permissions (RBAC)
      • Level of access
      • Organization RBAC
      • Project RBAC
    • Integrations
      • Git configuration
        • GitHub
        • Azure DevOps (ADO)
        • Bitbucket
        • GitLab
        • How to use
      • Cloud providers
        • AWS
        • Azure
        • GCP
        • OCI
  • Security
    • Data managed by Brainboard
    • SOC 2 Type II
    • Role Based Access Control
  • Help & FAQ
    • Shortcuts
    • FAQ
    • Migration
      • Import from cloud provider
    • Support
    • Glossary
  • Changelog
Powered by GitBook
On this page
  • Description
  • How to create a connector
  • How to delete a connector
  • How to edit a connector
  • Connector options bar
  • Connector options

Was this helpful?

Edit on GitHub
  1. Cloud design
  2. Design area

Connectors

PreviousID cardNextVersioning

Last updated 10 months ago

Was this helpful?

Description

A connector is a line that connects two resources in the architecture. It is used to show a relationship between two resources. There are two types of connectors:

  • Visual connectors: Are used to show a visual relationship between two resources. They are represented by a solid line.

  • Relationship connectors: Are used to show a relationship between two resources and can be depends_on or normal relationship connectors. They are represented by a solid line with the corresponding text in the middle of the connector: depends_on if it's a depends_on relationship connector or the name of the relationship if it's a normal relationship connector, eg server_name.

How to create a connector

To create a visual connector, you need to follow these steps:

  1. Select a resource by clicking on it and then select the Add connector option from the node options.

  1. Click the generated connector and drag it over the resource you want to connect it to.

  2. Release the connector over the resource you want to connect it to.

To create a depends_on relationship connector, you need to follow these steps:

  1. Select a resource by clicking on it and open its cloud configuration by clicking on the Cloud configuration button from the node options bar.

  1. Either scroll to the Extra attributes section, expand it and click on the Depends on input or using the search bar, search for Depends on.

  1. Clicking on the Depends on input will recommend you resources that you can connect to. You can either click on the resource you want to connect to or type the name of the resource you want to connect to.

  2. After selecting an item from the list, a connector will be created between the two resources. It will also have a text in the middle of the connector that says depends_on and the automatically generated Terraform code will have the depends_on attribute added to the resource.

To create a normal relationship connector, you need to follow these steps (the initial steps are the same as for the depends_on relationship connector):

  1. Select a resource by clicking on it and open its cloud configuration by clicking on the Cloud configuration button from the node options bar.

  1. Select an input (eg Key vault secret id) or use the search bar to search for an input.

  2. Clicking on the input will recommend you resources that you can connect to. You can either click on the resource you want to connect to or type the name of the resource you want to connect to.

  3. After selecting an item from the list, a connector will be created between the two resources. It will also have a text in the middle of the connector that refers to the field that connects the two resources (eg key_vault_secret_id).

How to delete a connector

To delete a connector, you need to follow these steps:

  1. Select the connector by clicking on it and then press the Delete key on your keyboard.

  2. Select the connector start or end point and select the Delete connector option from the connector options or press the Delete key on your keyboard.

How to edit a connector

To edit a connector, you need to follow these steps:

  1. Select the connector by clicking on it and the connector options bar will appear just under the design area options bar.

  1. Select the connector start or end point and the connector options will appear on the right side, just next to the selected point.

Connector options bar

The connector options bar allows you to visually configure the connector and it has the following options:

  • Fill color: Allows you to change the connector fill color.

  • Border weight: Allows you to change the connector border weight.

  • Border dash: Allows you to change the connector border dash.

  • Connector type: Allows you to change the connector type visually, from a straight line to a curved line.

  • Connector start shape: Allows you to change the connector start shape, from nothing, to a circle, square or arrow.

  • Connector end shape: Allows you to change the connector end shape, from nothing, to a circle, square or arrow.

Connector options

The connector options allow you to configure the connector and it has the following options:

  • Edit text: Allows you to edit the connector text.

  • Unlink connector: Allows you to unlink the connector from the target resource so that it can be moved freely and connected to another resource.

  • Delete connector: Allows you to delete the connector.

Visual connector
Depends_on connector
Relationship connector
Add connectors button
Node cloud configuration button
Node cloud configuration
Depends_on connector
Node cloud configuration button
Relationship connector
Delete connector button
Connector options bar
Connector icon options
Connector fill color
Connector border weigth
Connector border dash
Connector type
Connector start shape
Connector end shape
Connector edit text
Unlink connector
Delete connector