Rollouts

A Rollout defines which Distribution should be deployed to which Fleet of Assets. These Assets need to have the Edge Updater service running.

An Asset with Updater Service can be created individually in Studio or by using a USB installer Image for Fleet Deployments.

You can access Rollouts by expanding the EdgeOps section.


Figure 1.

Create an Asset with Edge Updater

To create an Asset with the Edge Updater service, you need to select Edge updater service enabled as the Installation Type, and select an Access Control App that has the Cluster Scope and fill in the client secret.

  1. If you do not have an Access Control App yet with the cluster Scope, you should create one first and store the client secret somewhere safe.
    1. To create a new App, click New App.


    2. In the New App panel, enter the name and a description (optional).
    3. Set the Scopes to cluster.
    4. Set the Type to Client Credentials.


      Figure 2.
  2. From the Edge Ops menu, click Fleet Management, and then click New Asset .


  3. Set a name for your Asset, and set the Installation Type as Edge app updater service enabled.


    Figure 3.
  4. Set the Fleet Identifier. This should always be the same for every Asset you creat as part of this Fleet.
  5. Complete the steps as outlined in Create an Asset to finish creating the Asset.

Create a USB Installer Image with Edge Updater

To create a USB installer Image with the Edge Updater service, you need to select one of the Software options with Ota Edge Apps functionality. The Asset Control App required for an installer image already has the Scope cluster. That also works for the Updater Service.

Pay special attention to the "Fleet Identifier". The Fleet Identifier needs to be the same for every Asset you create as part of this Fleet. Each Asset created from this image will use this Fleet Identifier. However, if you want to also use manually created Assets in this Fleet, then you need to make sure the Fleet Identifier is the same for all.


Figure 4.

Create a Rollout

  1. From the Edge Ops > Rollout panel, click New Rollout.


    The New Rollout panel opens.
  2. Enter a Name and select the Fleet Identifier you used when creating the Assets.


    Figure 5.
  3. Select the desired Distribution and version, and set the Rollout Type to OTA Edge Apps.
    You will see the status "creating" after saving the Rollout. Use the Refresh button at the top of the list to get an updated status.


    Figure 6.
  4. Once the status reads "ready" you can deploy it (see "Edge Ops > Rollouts > Deploy a Rollout").
  5. The Rollouts list and the Rollout details pane will show how many Clusters were found as part of this Fleet. In this example there are 2. These two can also be found in the Fleet Management > Assets list.


    Figure 7.
    Tip: Rollouts are standalone; they are not versioned like Distributions. When you have a new Distribution you want to deploy to your Fleet, you need to create a new Rollout, specifying the same Fleet Identifier and the Distribution version desired.


    Figure 8.

    See "Deploy a Rollout" for more details on what happens when deploying these examples.

Deploy a Rollout

Any Rollout that has status "ready" can be deployed to the Fleet Assets.


Figure 9.

  1. Open the Rollout details pane. At the top of the pane you see three buttons:
    • Play: Start the rollout
    • Pause: Pause a rollout in progress (that is, remaining Assets to be updated will not receive the updates)
    • Resume: Continue the rollout and deploy to the remaining assets


    Figure 10.

    Use the Refresh button on the Rollout details pane or the Rollout list view to get an updated status.

    Once Play has been clicked, the Rollout will go into "running" mode. The Fleet Assets poll the update server, and at the next poll request the Asset will be sent the update files and instructions.


    Figure 11.
    After all Assets have processed the update, the status will change to "finished" (use the refresh button).


    Figure 12.

    In this example, the first rollout deployed version 1 of our distribution. This version consists of three Edge Applications.

  2. Navigate to the Fleet Management > Asset Details pane of one of the Assets of this Fleet and go to the Applications tab. You see that the three applications have been installed. They can not be manually updated or removed from this tab and a "Managed by Edge Updater service" notice is displayed. If you want to make changes you need to use the Rollout mechanism.


    Figure 13.
  3. The second rollout uses version 2 of our distribution. Use the same workflow as described above to deploy it.
    The status changes to "finished" when all assets have processed this Rollout (use the refresh button).


    Figure 14.
    This results in two applications being removed as you can see on the Asset details pane.


    Figure 15.