Skip to main content

Backing up and restoring Enterprise Server with Actions enabled

To restore a backup of your Enterprise Server instance when Actions is enabled, you must configure Actions before restoring the backup with Enterprise Server Backup Utilities.

About backups of Enterprise Server when using Actions

You can use Enterprise Server Backup Utilities to back up and restore the data and configuration for your Enterprise Server instance to a new instance. For more information, see Configuring backups on your instance.

However, not all the data for Actions is included in these backups. Actions uses external storage to store workflow artifacts and logs. This data is stored on your external provider, such as Azure blob storage, Amazon S3, Google Cloud Storage, or MinIO. As a result, Enterprise Server backups and Enterprise Server high availability configurations do not provide protection for the data stored on this external storage, and instead rely on the data protection and replication provided by the external storage provider, such as Azure, Google Cloud, or AWS.

Restoring a backup of Enterprise Server when Actions is enabled

To restore a backup of your Enterprise Server instance with Actions, you must manually configure network settings and external storage on the destination instance before you restore your backup from Enterprise Server Backup Utilities.

  1. Create a new instance with the "New Install" option. For installation instructions for the virtualization platform of your choice, see Setting up a Enterprise Server instance.

  2. In the Management Console, configure network settings and external storage for Actions on the destination instance. See Configuring Enterprise.

  3. After Actions is configured and enabled, to restore the rest of the data from the backup, use the ghe-restore command. For more information, see Configuring backups on your instance.

  4. Re-register your self-hosted runners on the destination instance. For more information, see Adding self-hosted runners.

  5. To ensure that the bundled actions that are pre-installed on your new instance are up to date, enter the following command.

    Shell
    ghe-config --unset 'app.actions.actions-repos-sha1sum'
    
    1. To apply the configuration, run the following command.

      Note

      During a configuration run, services on your Enterprise Server instance may restart, which can cause brief downtime for users.

      Shell
      ghe-config-apply
      
    2. Wait for the configuration run to complete.