Cloudgate
Start free trial
MenuClose

Deployments and rollbacks

A Deployment is one attempt to build and release a Service, with its own log, status and timings. This page covers the queue, what each status means, reading the log, cancelling, redeploying and rolling back.

Members can deploy and cancel

Every build, cron run, backup run and cloud change is a Deployment. You find them in three places: Deployments in the rail (everything you can reach, across Projects), an Environment’s Deployments tab, and each Service’s Deployments tab.

What you can do

  • Start a Deployment, and see it queue, build and go live.
  • Read its log live while it runs, or later.
  • Cancel a Deployment that is waiting or building.
  • Redeploy the source a Service already has.
  • Roll an Application back to an earlier Deployment’s image, without rebuilding.

Start and follow a Deployment

  1. Deploy

    On the Service’s Overview, press Deploy. Cloudgate answers “Deployment queued.” A push to the tracked branch does the same when Deploy automatically is on.

  2. Watch it move through the phases

    Open the Deployment. The phases card shows Clone, Build, Push and Update, and the log streams live underneath. Press Show it in the Dock to keep the log open while you move to other pages.

    cloudgate.octabyte.app/applications/…/deployments
    The log streams as the build runs; the phases show where it is.

  3. Check the result

    A Deployment ends as done, error or cancelled. The detail shows when it was queued, started and finished, and how long it took.

cloudgate.octabyte.app/deployments
Filter by Project or status, or show only the Services you have open.

What each status means

Status Meaning
pending Queued, waiting for its turn on the build host.
running Building or releasing now.
done Finished and live.
error Failed. The log says where.
cancelled Stopped by someone before it finished.
held Waiting for a Plan: the push changed both code and its entry in cloudgate.yaml.

A held build continues when the Environment’s Plan is applied or dismissed. Build now with saved settings builds the code with the settings already saved, ignoring the config change.

How the build queue works

Without an Enterprise license, each Server builds one Deployment at a time; the others wait as pending. With a license, the Cloudgate host builds up to the number set in Concurrent builds (self-hosted, Settings > Instance).

A queued Deployment survives a restart of Cloudgate. A running one is cut off by a restart, ends as error and is not started again: deploy again when Cloudgate is back.

Cancel a Deployment

Press Cancel on a pending, running or held Deployment. Cancelling a cron run stops that run only; the timetable keeps going.

Redeploy

Redeploy in the Service’s header builds the source the Service already has again, for example after you changed a variable. Variable changes need a Deployment to take effect.

Roll back to an earlier Deployment

  1. Turn on rollback points

    Open the Application’s Rollbacks tab and turn on Keep rollback points. From now on, every successful Deployment captures a snapshot.

  2. Pick a point

    The Rollback points list shows each one’s version, what it was built from, its image and when it was captured.

    cloudgate.octabyte.app/applications/…/rollbacks
    Each successful Deployment adds one point while the switch is on.

  3. Roll back

    Press Roll back on the point. The running Service is updated to that snapshot’s image. Nothing is rebuilt.

On a Server, a rollback restores the image and its settings at once, with no Deployment of its own. A static site in a cloud keeps the files of every Deployment instead; rolling back restores those files and runs as a Deployment.

What you cannot do

  • Roll back to a Deployment made before Keep rollback points was on. Turning it off keeps the points you already have.
  • Roll back a database or a Compose stack: they have no Rollbacks tab. Use backups for data.
  • Undo what a Deployment did to your data: a rollback changes the image, never a database.
  • Restart a Deployment cut off by a Cloudgate restart; deploy again instead.
  • Read a Deployment log older than 90 days.

Questions

Why is my Deployment stuck on pending?

It is waiting in the queue. Without an Enterprise license each Server builds one Deployment at a time, so a second one waits until the first finishes.

What does held mean?

A push changed both the code and the Service's entry in cloudgate.yaml. The build waits until that Plan is applied or dismissed, or until you press Build now with saved settings.

Can I roll back to a Deployment from before I turned on rollback points?

No. Rollback points are captured only while Keep rollback points is on, one per successful Deployment.

How long are Deployment logs kept?

Cloudgate keeps each Deployment log for 90 days, then removes it.

Something missing or wrong on this page? Email support@octabyte.io, or start a free trial and try it in the console.