Skip to main content

Module template

Module template 

Source
Expand description

Templates: one-click apps.

A template is metadata, variables and a set of apps. Deploying one into a project environment fills the variables (from the caller, a generator or a default), renders each app template into an ordinary crate::app::AppSpec, and creates the apps; each then deploys like any app, so the app pages, deployments, rollbacks and env editor work for them. A template’s app is named <instance>-<key> (the main app just <instance>), and apps reach each other as <app>.<project>-<env>, written ${host:KEY} in a template.

Secret variables (generated passwords and keys) become org secrets (tpl.<instance>.<var>); a value built from one (a connection string) becomes its own secret, and so does every file. Stored app definitions hold only references.

catalog holds the built-in templates and the catalogs a platform admin adds; dokploy translates Dokploy’s format into this one.

Modules§

catalog
Where templates come from: the catalog built into the binary, and the catalogs a platform admin adds (a directory on the host or an https URL; isb’s own format, Dokploy’s or Coolify’s).
coolify
Coolify’s template format, translated into isb’s.
dokploy
Dokploy’s template format, translated into isb’s.
generate
Values for generated template variables: passwords, keys, ids, ports, timestamps and signed JWTs. Randomness comes from the OS (ring).

Structs§

AppTemplate
One app of a template: the fields of an AppSpec with an image source, as strings that may use ${var} and ${host:KEY}.
Context
What the host contributes.
FileTemplate
A file an app gets, rendered and stored as an org secret.
Instance
A deployed instance, kept so it can be listed and removed as one.
JwtSpec
Params
Where a template is deployed, and the deployer’s values.
Plan
Everything a deploy will create.
PlannedSecret
A secret the deploy creates.
PlannedVar
A variable’s outcome; secret values are never shown.
Stopped
How a template deploy that did not finish stopped.
Template
A template, as written in YAML (docs/guides/templates.md).
Variable

Enums§

VarKind
What a variable holds, and how it gets a value nobody gave.

Functions§

app_name
The app name for template app key in instance.
plan
Render a template into what a deploy creates. Pure apart from the generators and ctx.
secret_prefix
The prefix of every secret an instance owns.
skopeo_entrypoint
An OCI image’s entrypoint, read with skopeo inspect --config (within a minute). None: the image has none.
var_secret
The secret a template variable is stored as.

Type Aliases§

EntrypointFn
An image’s entrypoint (None: it has none), for apps with args.