Blueprints are ways to create customized starting points for Devboxes. They allow you to define custom starting points for Devboxes such that environment set up can be cached to improve Devbox boot times.
Blueprints are ways to create customized starting points for Devboxes. They allow you to define custom starting points for Devboxes such that environment set up can be cached to improve Devbox boot times.
The name of the Blueprint.
The status of the Blueprint build.
Available options:
provisioning,
building,
failed,
build_complete
The state of the Blueprint.
Available options:
created,
deleted
Creation time of the Blueprint (Unix timestamp milliseconds).
The parameters used to create Blueprint.
Dockerfile contents to be used to build the Blueprint.
parameters. system_setup_commands
A list of commands to run to set up your system.
A list of code mounts to be included in the Blueprint.
parameters.code_mounts. repo_name
The name of the repo to mount. By default, code will be mounted at /home/user/{repo_name}s.
parameters.code_mounts. repo_owner
parameters.code_mounts. install_command
Installation command to install and setup repository.
parameters.code_mounts. token
The authentication token necessary to pull repo.
parameters. launch_parameters
Parameters to configure your Devbox at launch time.
parameters.launch_parameters. launch_commands
Set of commands to be run at launch time, before the entrypoint process is run.
parameters.launch_parameters. resource_size_request
Manual resource configuration for Devbox. If not set, defaults will be used.
Available options:
X_SMALL,
SMALL,
MEDIUM,
LARGE,
X_LARGE,
XX_LARGE,
CUSTOM_SIZE
parameters.launch_parameters. keep_alive_time_seconds
Time in seconds after which Devbox will automatically shutdown. Default is 1 hour.
parameters.launch_parameters. available_ports
A list of ports to make available on the Devbox. Only ports made available will be surfaced to create tunnels via the 'createTunnel' API.
parameters.launch_parameters. after_idle
Configure Devbox lifecycle based on idle activity. If after_idle is set, Devbox will ignore keep_alive_time_seconds.
parameters.launch_parameters.after_idle. idle_time_seconds
After idle_time_seconds, on_idle action will be taken.
parameters.launch_parameters.after_idle. on_idle
Action to take after Devbox becomes idle.
Available options:
shutdown,
suspend
parameters.launch_parameters. custom_cpu_cores
custom resource size, number of cpu cores, must be multiple of 2.
parameters.launch_parameters. custom_gb_memory
custom memory size, number in Gi, must be a multiple of 2.
(Optional) Map of paths and file contents to write before setup..
parameters.file_mounts. {key}
The failure reason if the Blueprint build failed, if any.
Available options:
out_of_memory,
out_of_disk,
build_failed
