1. Create a snapshot of the configuration using the <PolicyUrl>/policy/risk/v1/snapshots REST API endpoint. For example:

   curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
   --data '{
       "name":"Backup Snapshot <DATE>",
       "description": "This is a snapshot from <DATE>"
   }'

   For details about finding the PolicyUrl and authenticating, see OAA Admin API.

   For more details about the snapshot endpoint, see Snapshot REST Endpoints.

   The above command will return a snapshotId, for example:

   {
       "status": "201",
       "message": "Snapshot created successfully.",
       "snapshot": {
           "name": "Backup Snapshot <DATE>",
           "description": "This is a snapshot from <DATE>",
           "snapshotId": "3",
           "createTime": "<DATE>"
       }
   }

2. Export the snapshot to a zip file using the snapshotId returned above, as follows:

   curl --location --request GET '<PolicyUrl>/policy/risk/v1/snapshots/<snapshotId>' \
   --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' >snapshot<DATE>.zip

   Store the downloaded zip file in a safe and secure location.

The instructions below can be used to perform the following:

• A full system restore, where you need to perform a full restore of the file system data, the database (runtime data), and policy and configuration data, to the existing installation. This will restore the environment to the point the last full backup was taken.
• A partial restore, where you only need to restore one of either system data, policy and configuration data, the database, or a combination thereof, to the existing installation.

1. If the database needs to be restored, restore the database using standard database recovery techniques. Consult your Oracle Database documentation for further details.
2. If OAA/OARM file system data needs to be restored, follow section Restoring file system data to an existing installation in Restoring OAA/OARM File System Data.
3. Restart the OAA/OARM pods by running the following command:

    kubectl get deployment -n <namespace> | grep <deployment-name> | awk '{print $1}' | xargs kubectl rollout restart deployment -n <namespace>

   For example:

   kubectl get deployment -n oaans | grep oaainstall | awk '{print $1}' | xargs kubectl rollout restart deployment -n oaans

   The output will look similar to the following:

   deployment.apps/oaainstall-email restarted
   deployment.apps/oaainstall-fido restarted
   deployment.apps/oaainstall-oaa restarted
   deployment.apps/oaainstall-oaa-admin-ui restarted
   deployment.apps/oaainstall-oaa-kba restarted
   deployment.apps/oaainstall-oaa-policy restarted
   deployment.apps/oaainstall-push restarted
   deployment.apps/oaainstall-risk restarted
   deployment.apps/oaainstall-risk-cc restarted
   deployment.apps/oaainstall-sms restarted
   deployment.apps/oaainstall-spui restarted
   deployment.apps/oaainstall-totp restarted
   deployment.apps/oaainstall-yotp restarted
   deployment.apps/oaamgmt-oaa-mgmt restarted

   The above command starts new OAA/OARM pods first, before shutting down the original pods.

   Run the following command to check the status of the pods:

   kubectl get pods -n <namespace>

   For example:

   kubectl gets pods -n oaans

   Once all the previous pods are terminated, and the new pods are at READY 1/1, the system is restored:

   NAME                             READY   STATUS    RESTARTS   AGE
   oaainstall-email-75cccd89f8-9xrgs          1/1     Running   0          5m34s
   oaainstall-fido-68777f8cc8-pfw8c           1/1     Running   0          5m34s
   oaainstall-oaa-74d5669788-lj5cp            1/1     Running   0          5m34s
   oaainstall-oaa-admin-ui-585d55c45b-fzdvk   1/1     Running   0          5m34s
   oaainstall-oaa-kba-5b9db9f8db-zwkh2        1/1     Running   0          5m34s
   oaainstall-oaa-policy-559fb4d777-qjvwm     1/1     Running   0          5m34s
   oaainstall-push-6898c6cb56-l4mg2           1/1     Running   0          5m34s
   oaainstall-risk-cc-db558dc5c-qlh8q         1/1     Running   0          5m34s
   oaainstall-risk-f48b794bc-j46pz            1/1     Running   0          5m34s
   oaainstall-sms-659677b84b-wf7sn            1/1     Running   0          5m34s
   oaainstall-spui-6fc8685df9-fhp9w           1/1     Running   0          5m33s
   oaainstall-totp-cccd94786-622qd            1/1     Running   0          5m33s
   oaainstall-yotp-5fbfd55d4c-d6wqn           1/1     Running   0          5m33s
   oaamgmt-oaa-mgmt-94f84ccc6-gwdp2           1/1     Running   0          5m32s
   

4. If you need to import any policy and configuration data from snapshots taken after the last database backup, follow Restoring OAA/OARM Policy and Configuration Data.

This scenario assumes you want to clone the existing installation to a new environment, using system data, and/or policy and configuration data, from the existing environment. In this scenario no runtime data is restored.

To restore file system data to the same environment:

1. Copy the file system data from the backup to the NFS volumes <NFS_CONFIG_PATH>, <NFS_CREDS_PATH>, <NFS_LOGS_PATH>, and <NFS_VAULT_PATH>.
2. Review the <NFS_CONFIG_PATH>/installOAA.properties file and ensure all the external resources such as NFS, the Oracle Database, and OAM OAuth endpoints are available and running.
3. Check if the OAA Management container is running:

   kubectl get pods -n <namespace> | grep oaamgmt

   For example:

   kubectl get pods -n oaans | grep oaamgmt

4. If the OAA Management container isn't running, you must perform the following steps:
   1. Copy the installOAA.properties from the <NFS_CONFIG_PATH> to the $WORKDIR/oaaimages/oaa-install directory.
   2. Start the OAA Management by following: Creating the Management Container.
5. Continue with the instructions to restart the OAA/OARM pods in section Restoring to an Existing Installation .

To restore file system data to a new environment:

1. Copy the file system data from the backup to the NFS volumes <NFS_CONFIG_PATH>, <NFS_CREDS_PATH>, <NFS_LOGS_PATH>, and <NFS_VAULT_PATH>.
2. Review the <NFS_CONFIG_PATH>/installOAA.properties file and ensure all the external resources such as NFS, the Oracle Database, and OAM OAuth endpoints are available and running.

   Note:

   If you are restoring to a new system and/or database, make sure all the relevant parameters reference the new system and/or database.
3. Remove the <NFS_LOGS_PATH>/status.info file.
4. Copy the installOAA.properties from the <NFS_CONFIG_PATH> to the $WORKDIR/oaaimages/oaa-install directory.
5. Start the OAA Management Container by following: Creating the Management Container.
6. Run the OAA install script from inside the OAA Management container. See Deploying OAA, OARM, and OUA. This will create a new deployment based on your restored OAA/OARM file system data.

To restore from a previous snapshotId:

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/<snapshotId>/apply' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data ''

To restore from a snapshot zip file:

1. Import the snapshot zip file:

   curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
   --header 'Content-Type: application/octet-stream' \
   --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
   --data-binary '@<PATH>/snapshot<DATE>.zip'

   This will return a snapshotId:

   {
     "status": "201",
     "message": "Snapshot created successfully.",
     "snapshot": {
       "name": "Backup Snapshot <DATE>",
       "description": "This is a snapshot from <DATE>",
       "snapshotId": "4",
       "createTime": "<DATE>"
     }
   }

2. Apply the snapshot:

   curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/<snapshotId>/apply' \
   --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
   --data ''

   The output will be similar to the following:

   {
     "serverResponseTime": 1683106368000,
     "clientContext": {
       "invocationContext": {
         "createTime": 1683106335536,
         "invocationId": "d61f7f30-a264-4be0-bb2d-9e5e88c58d19",
         "traceDataXml": "<OARMInvocationContext><invocationId><![CDATA[d61f7f30-a264-4be0-bb2d-9e5e88c58d19]]></invocationId><locale></locale><createTime><DATE></createTime></OARMInvocationContext>"
       },
       "sessionContext": {
         "sessionId": "",
         "clientId": "",
         "clientVersion": "",
         "userPrincipal": "",
         "ipAddress": "",
         "userAgent": "",
         "createTime": 1683106335537,
         "appName": "UASPolicyApi",
         "accessControlledRole": false,
         "orgAccessList": [],
         "roles": [],
         "traceDataXml": "<OARMSessionContextOARMSessionContext><clientId></clientId><userAgentString></userAgentString><userPrincipal></userPrincipal><roles><![CDATA[[]]]></roles><ip></ip><clientVersion></clientVersion><createTime><DATE></createTime></OARMSessionContextOARMSessionContext>"
       },
       "taskContext": {
         "taskId": "d61f7f30-a264-4be0-bb2d-9e5e88c58d19",
         "createTime": 1683106335536,
         "traceDataXml": "<OARMTaskContext><taskId><![CDATA[d61f7f30-a264-4be0-bb2d-9e5e88c58d19]]></taskId><createTime><DATE></createTime></OARMTaskContext>"
       },
       "traceDataXml": "<clientContext><OARMSessionContextOARMSessionContext><clientId></clientId><userAgentString></userAgentString><userPrincipal></userPrincipal><roles><![CDATA[[]]]></roles><ip></ip><clientVersion></clientVersion><createTime><DATE></createTime></OARMSessionContextOARMSessionContext><OARMTaskContext><taskId><![CDATA[d61f7f30-a264-4be0-bb2d-9e5e88c58d19]]></taskId><createTime><DATE></createTime></OARMTaskContext><OARMInvocationContext><invocationId><![CDATA[d61f7f30-a264-4be0-bb2d-9e5e88c58d19]]></invocationId><locale></locale><createTime><DATE></createTime></OARMInvocationContext></clientContext>"
     },
     "object": true,
     "error": false,
     "success": true,
     "oarmmessages": [],
     "warning": false,
     "serverVersion": "11.1.1.2.0",
     "systemError": false,
     "serverId": "oaainstall-oaa-policy-77bccf774b-48b6s/10.244.1.206",
     "traceDataXml": "<OARMResponse><serverId><![CDATA[oaainstall-oaa-policy-77bccf774b-48b6s/10.244.1.206]]></serverId><status><![CDATA[SUCCESS]]></status><serverResponseTime><DATE></serverResponseTime><serverVersion><![CDATA[11.1.1.2.0]]></serverVersion><messageList></messageList></OARMResponse>"