Skip to Content
How-to guidesCreate a manifest

Create a manifest

Save a recipe once and start identical spaces from it every time. Make one manifest per repository, or one per team workflow, such as “backend with Postgres” or “docs site preview”. A manifest pins one version of a stack and adds your own packages and settings on top. You start spaces and runs from manifests.

Before you start

Steps

  1. In the left rail, open Manifests.
  2. Click New manifest.
  3. Enter a Name.
  4. Under Stack, choose a stack. The first choice, “Pick one”, is empty. Under Version, choose a version.
  5. If the Owner field is shown, choose who owns the manifest: you, a team you lead, or the organization (admins). The default is you.
  6. Optional: set Auto-stop minutes and Compute class. Leave Compute class on its default to use the stack or organization default.
  7. Optional: add or remove packages. Click + Add package, tick the packages you want (Select all and Select none act on the list as filtered), and click Add. You can also use the Search packages… box to find a module that is already in the manifest.
  8. Click Create.

To start every new space from this manifest, click the star on its row (Set as default for new spaces). Click it again to remove the default.

The row menu (More actions) has Clone, Move, and Send a copy. A sent copy arrives as a new manifest owned by the other person, without credentials. They review it before their first launch.

Add several databases of one kind

Keep your staging and production databases in the same manifest. Database packages that support several instances show an Add instance button in the package panel. Packages without it take one instance.

  1. In the manifest editor, open the package, for example your ClickHouse package.
  2. Click Add instance.
  3. Enter an alias such as staging or prod. Use lowercase letters, digits and -, start with a letter, and keep it to 31 characters or fewer. Each alias is unique within its package.
  4. Choose the credential for that instance, then click Add.
  5. Repeat for each database, up to the package’s limit (never more than 10). Click Save.

The first instance needs no alias and works as it always has. Each extra instance has its own row with its alias and credential, and the status shows which row still needs a credential.

The package keeps one card in the editor, with the count beneath its name, such as 2 instances. The card shows needs cred while any instance is still missing its credential, and configured once every instance has one. Open the card to manage all of its instances.

In the space, the agent gets every instance as its own connection, named after the package and the alias, such as clickhouse-prod. The agent’s instructions name each alias, so it knows which database is staging and which is prod.

Every instance is a connection on the same package, so it always runs that package’s version. Each instance row in the editor shows the package version with follows package, for example v1.0.7 · follows package. When you upgrade the package, by hand or through auto-update, every instance moves with it. If a manifest pins a version that is no longer installed, Marshal names the missing version and the installed one.

What you should see

  • The new manifest in the table, grouped under its owner.
  • In the Status column, a check mark and “ready” when every credential is in place. An amber “missing 2 credentials” means you can launch now, and agents get a “not authenticated” error when they call those integrations. A red “add 2 credentials” means your organization requires them before launch. Either way, connect them on the Connections page. An amber “needs org credential” on an org or team manifest means no credential with the name the manifest uses is reachable for its owner, for example a credential that only you hold. Add one at org scope, or share it with the org. Runs started with an API key or by a deputy are refused when the agent has no credential it can reach, until you do. A space you launch yourself still starts.
  • A Launch button on its row when you may launch it.
  • Spaces you start from it use the stack version you pinned. Later edits apply to new spaces at once. A running space keeps what it started with, and a stopped space picks the edits up when you resume it.

Next

Create a space from a manifest: click Launch and get a running agent.

Set package settingsBuild and publish a stack