Send Docs Feedback

How to Perform a Backup

Edge for Private Cloud v. 4.17.05

When backing up a complete Edge installation, you must back up all components. See "What to Backup" at Backup and Restore for more.  

Use the following command to perform a backup:

> /opt/apigee/apigee-service/bin/apigee-service comp backup

where comp is the name of the component. For example:

> /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra backup

The backup utility writes the generated backup file to /opt/apigee/backup/comp where comp is the name of the component. Because you can generate many backup files, and because these files can get large, you can mount a separate disk at /opt/apigee/backup just for backup files.

For PostgreSQL only, you can optionally create a network storage snapshot as an alternative to using the Apigee backup command. This snapshot cab be useful because the Apigee backup command takes time to run and PostgreSQL data generated while the backup runs could be omitted from the resulting .dump file. 

The backup command: 

  1. Stops the component (except for PostgreSQL which must be running to backup).

    Note: As of Edge 4.17.05.01 the backup procedure no longer shuts down Cassandra.
  2. Creates a tar file of the following directories and files, where comp is the name of the component:
    1. Directories
      • /opt/apigee/data/comp
      • /opt/apigee/etc/comp.d
    2. Files if they exists
      • /opt/apigee/token/application/comp.properties
      • /opt/apigee/customer/application/comp.properties
      • /opt/apigee/customer/defaults.sh
      • /opt/apigee/customer/conf/license.txt
  3. For all components except PostgreSQL, writes the tar file to /opt/apigee/backup/comp. The name is in the form:
    backup-(year).(month).(day),(hour).(min).(seconds).tar.gz 

    For example:
    backup-2016.03.17,14.40.41.tar.gz 

    For PostgreSQL, the file is named:
    (year).(month).(day),(hour).(min).(seconds).dump
  4. Restarts the component (except for PostgreSQL and Cassandra which must be running to backup).

If you have multiple Edge components installed on the same node, you can back up them all with a single command:

> /opt/apigee/apigee-service/bin/apigee-all backup

This command creates a backup file for each component on the node.

Help or comments?