Chapter 7. Backup and disaster recovery

1. To create a backup snapshot and send it to a pre-configured backup server:

   $ crwctl server:backup --repository-url=<repository-url> --repository-password=<repository-password>

   • You can create other backups to the same backup server using the server:backup command with no arguments.
   • Using the server:backup command with no arguments for the first time will configure and use an internal backup server.

1. Create a CheClusterBackup object to create a new backup:

   apiVersion: org.eclipse.che/v1
   kind: CheClusterBackup
   metadata:
     name: CodeReady Workspaces-backup
   spec:
     backupServerConfigRef: backup-server-configuration 1

1. Create a new object of CheClusterRestore to recover a CodeReady Workspaces installation from a backup:

   apiVersion: org.eclipse.che/v1
   kind: CheClusterRestore
   metadata:
     name: CodeReady Workspaces-restore
   spec:
     backupServerConfigRef: backup-server-configuration 1
     snapshotId: ba92c7e0                               2

Verification

1. Verify backup process state:

   1. Read the status section of the CheClusterBackup object to check the backup process:

      status:
        message: 'Backup is in progress. Start time: <timestamp>' 1
        stage: Collecting CodeReady Workspaces installation data          2
        state: InProgress                                         3
        snapshotId: ba92c7e0                                      4

      1

      Displays the overall state or error message.

      2

      Current phase of the backup process in a human-readable format.

      3

      Backup process state. One of InProgress, Succeeded, or Failed.

      4

      ID of the created backup snapshot. The field appears only when state is Succeeded.

2. Verify recovery process state

   1. Read the status section of the CheClusterRestore object to check the recovery process:

      status:
        message: 'Restore is in progress. Start time: <timestamp>' 1
        stage: Restoring CodeReady Workspaces related cluster objects      2
        state: InProgress                                          3

      1

      Overall state or error message.

      2

      Current phase of the recovery process in a human-readable format.

      3

      Recovery process state. One of InProgress, Succeeded, or Failed.

Procedure

1. Define the values of the following placeholders:

   • <database-user> is the CodeReady Workspaces server database user name
   • <database-password> is the CodeReady Workspaces server database password
   • <database> is the CodeReady Workspaces server database name

2. Use the following SQL script to create a user and a database for the CodeReady Workspaces server to make workspace metadata persistent:

   CREATE USER <database-user> WITH PASSWORD '<database-password>'
   CREATE DATABASE <database>
   GRANT ALL PRIVILEGES ON DATABASE <database> TO <database-user>
   ALTER USER <database-user> WITH SUPERUSER

3. Define the value of the following placeholder:

   • <identity-database-password> is the RH-SSO database password

4. Use the following SQL script to create a database for the RH-SSO back end to make the user information persistent:

   CREATE USER keycloak WITH PASSWORD '<identity-database-password>'
   CREATE DATABASE keycloak
   GRANT ALL PRIVILEGES ON DATABASE keycloak TO keycloak

Procedure

1. Pre-create a project for CodeReady Workspaces:

   $ oc create namespace openshift-workspaces

2. Create a secret to store CodeReady Workspaces server database credentials:

   $ oc create secret generic <server-database-credentials> \ 1
   --from-literal=user=<database-user> \                            2
   --from-literal=password=<database-password> \                    3
   -n openshift-workspaces

   1

   Secret name to store CodeReady Workspaces server database credentials

   2

   CodeReady Workspaces server database username

   3

   CodeReady Workspaces server database password

3. Create a secret to store RH-SSO database credentials:

   $ oc create secret generic <identity-database-credentials> \ 1
   --from-literal=password=<identity-database-password> \             2
   -n openshift-workspaces

   1

   Secret name to store RH-SSO database credentials

   2

   RH-SSO database password

4. Deploy Red Hat CodeReady Workspaces by executing the crwctl command with applying a patch. For example:

   $ crwctl server:deploy --che-operator-cr-patch-yaml=patch.yaml ...