How to back up

Use the following command to perform a backup:

/opt/apigee/apigee-service/bin/apigee-service component_name backup

Where component_name is the name of the component. Possible values include:

apigee-cassandra (Cassandra)
apigee-openldap (OpenLDAP)
apigee-postgresql (PostgreSQL database)
apigee-qpidd (Qpidd)
apigee-sso (Edge SSO)
apigee-zookeeper (ZooKeeper)
edge-management-server (Management Server)
edge-management-ui (new Edge UI)
edge-message-processor (Message Processor)
edge-postgres-server (Postgres Server)
edge-qpid-server (Qpid Server)
edge-router (Edge Router)
edge-ui (Classic UI)

For example:

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

Warning: The backup utility writes the generated backup file to /opt/apigee/backup/component_name where component_name 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.

Note: 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.

To perform a backup:

Stop the component (except for PostgreSQL and Cassandra which must be running to backup):
```
/opt/apigee/apigee-service/bin/apigee-service component_name stop
```
Run the backup command:
```
/opt/apigee/apigee-service/bin/apigee-service component_name backup
```
The backup command then:
- Creates a tar file of the following directories and files, where component_name is the name of the component:
  1. Directories
    - /opt/apigee/data/component_name
    - /opt/apigee/etc/component_name.d
  2. Files if they exist
    - /opt/apigee/token/application/component_name.properties
    - /opt/apigee/customer/application/component_name.properties
    - /opt/apigee/customer/defaults.sh
    - /opt/apigee/customer/conf/license.txt
- Creates a .tar.gz file in the /opt/apigee/backup/component_name directory. The file name has the following form:
```
backup-year.month.day,hour.min.seconds.tar.gz
```
  For example:
```
backup-2018.05.29,11.13.42.tar.gz
```
  For PostgreSQL, the file name has the following form:
```
year.month.day,hour.min.seconds.dump
```
Start the component (except for PostgreSQL and Cassandra which must be running to backup):
```
/opt/apigee/apigee-service/bin/apigee-service component_name start
```

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.