Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The backup process of the Kyvos external repository for AWS (RDS) and Azure (Postgres) has been automated during the upgrade. Similarly, the Kyvos external repository for AWS (RDS) and Azure (Postgres) restoration process has have been automated during the rollback.

...

Manually creating Kyvos external repository for Azure
Anchor
Azure
Azure

From Kyvos 2023.5 onwards, if It is important to update the manually created backup information in Kyvos Manager. This will ensure that Kyvos Manager can still automate the restoration of the database to the correct state even if the backup of the repository failed during the Kyvos upgrade.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

This applies to Kyvos Enterprise (for external repository based deployment)

Creating Dump File

Aura tab collection
paramsJTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlN0QlMkMlMjJhY3RpdmUlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzZjU4MjI3JTIyJTdEJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSUyMiUyM2RmZTFlNiUyMiU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIyY29sb3IlMjIlM0ElMjIlMjM1ZTZjODQlMjIlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSUyMiUyMzVlNmM4NCUyMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJ3aWR0aCUyMiUzQTElMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyM2NjY2VjZiUyMiU3RCU3RCU3RCU3RA==
Aura tab
summaryAzure Postgres backup
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMFBvc3RncmVzJTIwYmFja3VwJTIwJTIyJTdE
panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFAE6

Important

From Kyvos 2023.5 onwards, It is important to update the manually created backup information in Kyvos Manager. This will ensure that Kyvos Manager can still automate the restoration of the database to the correct state even if the backup of the repository failed during the Kyvos upgrade.

Anchor
creatingdumpfile
creatingdumpfile
  1. To create a data dump file, set the environment variable path for library file by executing the following command:
    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/data/kyvos/app/kyvos/postgres/lib

  2. Create the Azure Postgres dump.
    NOTE: This must be done when the BI Server is in stop state.
    Execute the following command:
    ./pg_dump -c -C --host=<host> --port=<port> --dbname=<database name> --user=<user name> --password=<password> <file name>
    For example,
    ./pg_dump -c -C "host=kyvos-postgresserver-1010.postgres.database.azure.com port=5432 dbname=delverepo user=postgres@kyvos-postgresserver-1010 password=delve@123" > Kyvos2023-5-Build026-014-D2023-Nov-14-T12-46-41NOTE: You can also create and upload a tar file using the Upload Data Dump file option.

  3. Save the Azure Postgres dump otherwise the rollback to this state will not be possible.

Uploading the Dump file

If backup of external repo fails during Kyvos upgrade, the Kyvos Manager prompts for the Database dump state of the current repository. In this case, you have two ways: either provide the path of dump file in DFS (abfs) or upload that dump file from Kyvos Manager. Using available permissions in the environment, choose the best option for the user.

  1. Login to Kyvos Manager, the following page is displayed.

  2. In the message box, you will view the following options:

    1. Upload Data Dump File: To upload the data dump file you have created. For example Kyvos2023-5-Build026-014-D2023-Nov-14-T12-46-41. Refer to the Creating dump file section

    2. Storage Account: Provide the path of dump file in DFS (abfs) by using the Choose file option and then upload the dump file.

  3. Click Continue. Kyvos Manager will save the information of the created data dump file.

Aura tab
summaryAzure Postgres restore
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMFBvc3RncmVzJTIwcmVzdG9yZSUyMiU3RA==
Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFAE6

Important

From Kyvos 2023.5 onwards, It is important to restore the state of Database information in Kyvos Manager. This will ensure that Kyvos Manager can still automate the restoration of the database to the correct state even if the backup of the repository failed during the Kyvos upgrade.

Restoring Database dump

During restore failure while Kyvos rollback, Kyvos Manager will show a link to the Manage Kyvos Repository page prompts you to restore the state of DB using the dump file stored in abfs. The name of the dump file that is present at path setup/kyvos-releases-db-state-backups/ inside {ENGINE_WORKS} directory will be displayed in the dialog box (as shown in the below image) and Manage Kyvos Repository page to help you in understanding which dump exactly needs to be restored. You can create a new repository with that dump state or can restore the dump is the same existing repository used in the system.

  1. To restore database dump, execute the following command
    ./psql "host= <Database Server name> port=<Port number> dbname= <Database name> user= <User name> password= <Password>"-U ${user} -h ${hostname} -f ${filename}

    For example,
    ./psql "host=-U postgres -h kyvos-postgresserver-447163058.postgres.database.azure.com port=5432 dbname=delverepo user=postgres@kyvos-postgresserver-4471 password=delve@123$" -f databasedump
    -or-

    1. Click Go to Manage Kyvos Repository. You will be redirected to the Manage Kyvos Repository page.

    2. Provide the database Server Name details in which the dump is restored, and then click Fetch details.

    3. Before saving, click Test connection, and then click Save.

...