Versioning
Overview
Brainboard provides a native versioning mechanism that allows you to keep track of your changes and rollback/restore any specific point-in-time version.
This article lists the information that is saved for each version in Brainboard, in addition to steps for creating a new version, viewing already saved versions and restoring an existing version.
Components of a version
When you create a version, Brainboard saves the following information:
✅ The architecture design.
✅ The version of the cloud provider selected to create the architecture.
✅ Variables.
✅ Output.
✅ The README file.
✅ The structure of the Terraform files.
✅ Timestamp in UTC when the version is created.
✅The person who created the version.
✅ The commit message.
The Terraform code is automatically generated, and it is not saved as code.
How to create a version?
To create a version of your architecture, you can follow these steps:
Click on the version history icon in the top navigation bar. The Version history will open in the right pane.
Click the
New versionbutton on the Version history pane.
On the Create new version popup modal, you can enter the description of the version and click
Createto save.
The version description could be the same commit message you would write when performing a pull request. You can write multiline text if you want to provide more details.
When a version is created and saved, it's listed on the Version history pane on the right side.
Each new version that's created also displays the name of the user who created along with the time/date it was created.
View available versions
If you want to view the list of available versions of your architecture design, click on the version history icon in the top navigation bar. The Version history pane will expand on the right side of the screen.
The versions are listed in order of latest/newest to oldest.
How to restore a version?
To restore any version, click on the version history icon in the top navigation bar. On the Version history pane on the right side, click on the version you want to restore. The clicked version will be restored, and the following success message will be displayed at the bottom of the Version history pane.
Architecture version restored successfully.
IMPORTANT
Brainboard versions are immutable snapshots of your infrastructure. You cannot delete them.
You can check out any version and work on it without altering the history of the versioning.
When you clone an architecture or create a template from it, its versions will be removed.
When you checkout a version, both the diagram and the Terraform code will be updated.
Push to git
Please refer to the Pull requests page for detailed information on how to do pull requests and save the generated code into git.
Last updated