Making Releases Optional or Required


It is important to understand how Replicated gives you the tools to control your releases. We understand that you need the flexibility to run certain releases at certain times because certain releases will contain pertinent data, like database migrations.

Replicated gives you the ability to mark releases as optional or required when promoting them.

To mark a release as optional or required, navigate over to the Releases section of Vendor Web. Assuming the release in question has already been created, you should find it there:

Click on the Promote button to bring up the release’s configuration box:

Here, you can select to Allow this release to be skipped during upgrades or Require users to install this release:

Replicated will run your release per its Requirements configuration.

This also works in the case where you promote a release to a channel but later realize there is a issue, i.e., a live release has been marked as required and now should be skipped.


Would it be possible to provide some more detail/screenshots about how customer’s would experience a required release?


When the customer is more than one release behind, any intermediate required releases will be installed prior to installing the latest release. Intermediate releases that are not required will be skipped unless explicitly installed by the customer. Replicated will install the release and wait for the app to start and report ready before proceeding on from any required release to the next.

All intermediate releases will be listed in the UI /releases page and when the replicatedctl app-release ls command is run.

$ replicatedctl app-release ls
SEQUENCE            VERSION             RELEASE DATE                    INSTALL DATE                              REQUIRED
931                 1.0.3               2019-12-10 18:04:16 +0000 UTC   0001-01-01 00:00:00 +0000 UTC             false
928                 1.0.2               2019-12-10 18:04:03 +0000 UTC   0001-01-01 00:00:00 +0000 UTC             false
926                 1.0.1               0001-01-01 00:00:00 +0000 UTC   2019-12-10 18:02:54.676626475 +0000 UTC   false