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
  • Definition
  • Create a new project
  • View project's information
  • Edit project information
  • Edit project roles
  • Delete project
  • Project roles
  • Check permissions

Was this helpful?

Edit on GitHub
  1. Data
  2. Data structure

Project

PreviousData structureNextEnvironment

Last updated 6 months ago

Was this helpful?

Definition

A project is a container of environments and architectures to which teams have access with specific permissions.

Think of a project as the upper level folder.

By default, members don't have direct permissions on projects until the admin grants them access to.

Create a new project

To create a new project:

  • Go to the .

  • Click on the Create project button

  • You will then go through a project creation wizard.

    • In the first step of the wizard you will setup the name, description and environments of the new project. Brainboard creates 5 environments by default: Production, Staging, Development, Test and QA, but you can add any custom environment as well. The project name and at least one environment are required.

    • In the second step of the wizard, you will need to assign teams to roles. You can do that by doing a drag & drop action for each team into the corresponding role. You need to assign at least one team with the admin role.

    • The last step shows the summary of the new project: name, description, environment and the teams assigned to this project with their roles.

View project's information

To view the information on a specific project:

  • Click on the View details option that appears when you click on the three horizontal dots button at the end of the row for a project.

  • The information of the project is displayed:

    • Name of the project

    • Teams that have access to this project with their respective roles

    • The environments of the project

Edit project information

To edit the information on a project:

  • Click on the Edit project details option that appears when you click on the three dots button at the end of the row for a project.

  • You can then change the information about the project:

    • Name.

    • Description.

    • The environments that will be created.

  • Click on the disk icon from the top left of the drawer to save the new information about the project.

Edit project roles

To edit the teams & roles of a project:

  • Click on the Assign roles option that appears when you click on the three dots button at the end of the row for a project.

  • Here you can update the teams per role. You can do that by doing a drag & drop action for each team into the corresponding role. You need to assign at least one team to any role to advance.

  • Click on Update button to save the new information about the project.

Delete project

To delete a project:

  • Click on the Delete project button on the line of the project. You need to hover the line to see the options:

  • You'll be asked to confirm the deletion, if you confirm the project will be permanently deleted. The last project cannot be deleted, as your account needs at least one project.

Project roles

Granting access to a team or members, gives them access to the environments and architectures hosted inside the project.

Different roles can be granted to teams for the project, and you can create custom roles with custom permissions, but Brainboard comes with 4 default roles out of the box:

1. Admin

The members of a team having the admin role can perform any action on the project, its environments, architectures, versions, and deployments.

2. Designer

The members of a team having the designer role can perform any action as the admin team except modifying the project information or deleting it.

3. Operator

The members of a team having the operator role can manage the deployments only, they cannot change the design of the infrastructure.

4. Guest

The members of a guest team can only view the project, its architectures, and deployments. They cannot change anything.

Check permissions

To check the permissions a specific team has on a project:

  1. Click on project view

  2. Click on the role name.

This will display the permissions' table:

Go to the .

Go to the .

Go to the .

Go to the .

Go to

projects setting page
projects setting page
projects setting page
projects setting page
Roles page
projects setting page
Create a project
View project info
View project info
Assign roles
Create a project