Skip to content

Configuration as code

Describe environments in YAML, see exactly what would change, and apply it as a review.

1Write the document

Deploy → Configuration. Write a version 2 YAML document (the same format as Deployer). Names in placements, repositories and secret references are bound to records under Bindings: websites, this project’s repositories and secret variables.

2Plan

Choose Plan changes to see exactly what applying the document would change. Nothing changes yet, and objects the document doesn’t mention are left alone.

3Review and apply

Choose Create review. A review lasts 15 minutes and only its creator can apply it, as long as nothing has changed since. Applying gives a receipt that follows its deploys.

4Taking objects over

Objects that already exist but aren’t owned by configuration need adopt: true in the document; plan again after adding it.

5Workflows

Under Workflow (version 1), paste Deployer’s workflow format to set scheduled deploys, scaling, scaling schedules and processes per environment all at once. The same document can be sent to PUT /api/v1/projects/{project}/workflow.

Still stuck?Email us, or send feedback from inside the app.