Guides

Releases

A release is a version of software you can deploy to devices later: a name, version, kind (systemd, docker, or docker_compose), optional artifact, and kind-specific install spec.

Releases are organization-scoped. They reference artifacts by ID when the kind needs a file (systemd unit, compose bundle, or docker tarball). A docker release may omit an artifact and pull spec.image on the device instead.

Each device tracks desired vs installed software (GET .../devices/{id}/software). Desired state is set when you Deploy; agents report installed state over heartbeat. See Heartbeat.

API

Reading requires artifact.read. Creating and updating require artifact.create / artifact.update. Deleting requires artifact.delete.

MethodPathNotes
GET/api/v1/organizations/{org}/releasesFilters: kind, version, search, page, page_size
POST/api/v1/organizations/{org}/releasesJSON: name, version, kind, optional artifact_id, description, spec
GET/api/v1/organizations/{org}/releases/{id}
PATCH/api/v1/organizations/{org}/releases/{id}description and/or spec
DELETE/api/v1/organizations/{org}/releases/{id}

Spec by kind

KindArtifactSpec
systemdtype systemd (required)unit_name (required), start (default true)
dockertype docker tarball or none if pullingcontainer_name, and either image or an artifact
docker_composetype docker_compose (required)project_name, optional env

Uniqueness is per organization on kind + name + version (case-insensitive).

UI

Releases in the organization menu lists releases and lets you create one by choosing a deployment type:

  • systemd service — a Linux unit
  • Single container — one container via docker run
  • Compose application — an app run with Docker Compose (one or more services)

Then fill the matching artifact and install fields. The same flow can grow new kinds later (for example AI models) without a separate wizard.

Apply notes

  • systemd — agent installs the unit under /etc/systemd/system (needs root / meteorcli.service), then daemon-reload / enable / restart when start is true.
  • docker — pull spec.image and/or docker load a tarball, then docker run.
  • docker_compose — materialize YAML/zip and docker compose up -d.

Deployment provider

Releases always live in MeteorCloud. Who executes a Deploy is selected with DEPLOYMENT_PROVIDER (native, none, or mender stub). See Deployments.

Releases · MeteorCloud