Back Up an AWS OpsWorks for Chef Automate Server - AWS OpsWorks
Automated BackupsManual BackupsDelete backups

Back Up an AWS OpsWorks for Chef Automate Server

Important

AWS OpsWorks for Chef Automate reached end of life on May 5, 2024 and has been disabled for both new and existing customers. We recommend that existing customers migrate to Chef SaaS or an alternative solution. If you have questions, you can reach out to the AWS Support Team on AWS re:Post or through AWS Premium Support.

You can define a daily or weekly recurring AWS OpsWorks for Chef Automate server backup, and have the service store the backups in Amazon Simple Storage Service (Amazon S3) on your behalf. Alternatively, you can make manual backups on demand.

Because backups are stored in Amazon S3, they incur additional fees. You can define a backup retention period of up to 30 generations. You can submit a service request to have that limit changed by using AWS support channels. Content delivered to Amazon S3 buckets might contain customer content. For more information about removing sensitive data, see How Do I Empty an S3 Bucket? or How Do I Delete an S3 Bucket?.

You can add tags to backups of an AWS OpsWorks for Chef Automate server. If you have added tags to an AWS OpsWorks for Chef Automate server, automated backups of the server inherit those tags. For more information about how to add and manage tags on backups, see Working with Tags on AWS OpsWorks for Chef Automate Resources in this guide.

Automated Backups

When you configure your AWS OpsWorks for Chef Automate server, you choose either automated or manual backups. AWS OpsWorks for Chef Automate starts automated backups during the hour and on the day that you choose in the Automated backup section of the Configure advanced settings page of Setup. After your server is online, you can change backup settings by performing the following steps, either from the server's tile on the Chef Automate servers home page, or on the server's Properties page.

To change automated backup settings

  1. In the Actions menu of the server's tile on the Chef servers home page, choose Change settings

  2. To turn off automated backups, choose No for the Enable automated backups option. Save your changes; you do not need to go on to the next step.

  3. In the Automated Backup section, change the frequency, start time, or generations to keep. Save your changes.

Manual Backups

You can start a manual backup at any time in the AWS Management Console, or by running the AWS CLI create-backup command. Manual backups are not included in the maximum 30 generations of automated backups that are stored; a maximum of 10 manual backups are stored, and must be manually deleted from Amazon S3.

You can add tags when you create a new, manual backup of an AWS OpsWorks for Chef Automate server. For more information about how to add tags when you create a manual backup, see Add Tags to a New Backup (CLI).

To perform a manual backup in the AWS Management Console

  1. On the Chef Automate servers page, choose the server that you want to back up.

  2. On the properties page for the server, in the left navigation pane, choose Backups.

  3. Choose Create backup.

  4. The manual backup is finished when the page shows a green check mark in the backup's Status column.

To perform a manual backup in the AWS CLI

  • To start a manual backup, run the following AWS CLI command.

    aws opsworks-cm --region region name create-backup --server-name "Chef server name" --description "optional descriptive string"

Delete backups

Deleting a backup permanently deletes it from the S3 bucket in which backups are stored.

To delete a backup in the AWS Management Console

  1. On the Chef Automate servers page, choose the server that you want to back up.

  2. On the properties page for the server, in the left navigation pane, choose Backups.

  3. Choose the backup that you want to delete, and then choose Delete backup. You can select only one backup at a time.

  4. When you are prompted to confirm the deletion, fill the check box for Delete the backup, which is stored in an S3 bucket, and then choose Yes, Delete.

To delete a backup in the AWS CLI

  • To delete a backup, run the following AWS CLI command, replacing --backup-id with the ID of the backup that you want to delete. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS. For example, test-chef-server-20171218132604388.

    aws opsworks-cm --region region name delete-backup --backup-id ServerName-yyyyMMddHHmmssSSS