Skip to main content

Blueprints#

Definition#

Blueprints are the foundation for most Vessels. They contain the design specifications needed to start building solutions for your organization. As such, they live at the organization level and can be used in any Project. They can either be built by Shipyard staff (as part of the Blueprint Library) or created by users in your organization.

Blueprints provide a way for technical users to create a reusable piece of code with organization-specific logic. When using a Blueprint, users are only required to provide key inputs needed for the Vessel to work correctly. All code and requirements are abstracted away from the end user.

All Blueprints are built using Code. You must select a supported language and provide the necessary code, arguments, environment variables, and packages necessary to make the Blueprint usable. Additionally, you can create Blueprint Variables that users fill out on the Inputs tab when they are setting up a new Vessel.

When a Vessel is built with a Blueprint, it is considered to be a Dependendent Vessel for that Blueprint because it depends on the underlying structure and code. All dependent Vessels for a Blueprint, across all projects, can be viewed on the Dependent Vessels tab, giving a high level of visibility into status and usage of reusable solutions.

As a Blueprint author or editor, you are in charge of writing the code that runs for the users of your Blueprint. You can update and manage the underlying code, making updates in bulk that will affect hundreds of dependent Vessels.

Components#

Creating a Blueprint#

When creating a Blueprint, you must always provide the following elements:

You may also optionally provide these elements:

Building a Vessel#

When creating a Vessel with a Blueprint, you must always provide the following elements:

  1. Inputs (if any are required)
  2. Vessel Information

You may also optionally provide these elements:

  1. Triggers
  2. Notifications
  3. Guardrails

Additional Notes#

  1. Code for a Blueprint must have an adequate level of error handling and validation because it relies on user input.
  2. Notifications cannot currently be set for all Vessels that are built from a Blueprint.

Learn More#