Versions Compared

Old Version 1

changes.mady.by.user NIDHI BHANDARI

Saved on

compared with

New Version Current

changes.mady.by.user Sarabjeet Kaur

Saved on

Key

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

...

(error) Kyvos Azure Marketplace   (error) Kyvos GCP Marketplace (error) Kyvos Single Node Installation (Kyvos SNI)

This section describes how to manage Kyvos external repository.

...

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

...

have been automated during the rollback.

If the automated backup during the upgrade or restoration process fails during rollback, you must resume the steps from the point where it stopped previously. To do this,

...

follow the manual steps

...

mentioned in the below sections.

Manually creating Kyvos external repository for AWS 
Anchor
AWS
AWS

Aura tab collection
paramsJTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlN0QlMkMlMjJhY3RpdmUlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzZjU4MjI3JTIyJTdEJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSUyMiUyM2RmZTFlNiUyMiU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIyY29sb3IlMjIlM0ElMjIlMjM1ZTZjODQlMjIlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSUyMiUyMzVlNmM4NCUyMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJ3aWR0aCUyMiUzQTElMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyM2NjY2VjZiUyMiU3RCU3RCU3RCU3RA==
Aura tab
summaryRDS Backup
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJSRFMlMjBCYWNrdXAlMjIlN0Q=

You must follow the steps if automated backup fails during Kyvos upgrade or to backup RDS manually. The steps for explicit RDS DB backup must be followed.
Create a snapshot of your DB instance (RDS). To do this, go to your RDS database and take a snapshot.

For automated backup, you must provide the snapshot during the upgrade.

Image Added
Aura tab
summaryRDS restore
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJSRFMlMjByZXN0b3JlJTIwJTIyJTdE

If automated restore fails during Kyvos rollback, the steps for explicit restore of RDS must be followed.

Create a DB instance using this state of snapshot that was created before upgrade. For more details about restoring your DB instance from the DB snapshot, refer to AWS documentation.

Go to Kyvos Manager > navigate to the Manage Kyvos Repository page to perform the switch repository operation via which the above newly-created DB instance will be configured into the Kyvos system.

...

Manually creating Kyvos external repository for Azure
Anchor

...

Azure

...

Azure

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

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

Aura tab collection
paramsJTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlN0QlMkMlMjJhY3RpdmUlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzZjU4MjI3JTIyJTdEJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSUyMiUyM2RmZTFlNiUyMiU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIyY29sb3IlMjIlM0ElMjIlMjM1ZTZjODQlMjIlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSUyMiUyMzVlNmM4NCUyMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJ3aWR0aCUyMiUzQTElMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyM2NjY2VjZiUyMiU3RCU3RCU3RCU3RA==
Aura tab
summaryAzure Postgres backup
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMFBvc3RncmVzJTIwYmFja3VwJTIwJTIyJTdE
Before upgrading the Kyvos version in cluster, you must export

Creating Dump File
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:{KYVOS_HOME}/postgres/lib:{KYVOS_HOME}/postgres/librhel8

  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> <database>.sql<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" > data-dump.sqKyvos2023-5-Build026-014-D2023-Nov-14-T12-46-41

  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 face an error, such as: “./pg_dump: error while loading shared libraries: libpq.so.5: cannot open shared object file: No such file or directory”, then execute the LD_LIBRARY_PATH command, for example: export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/data/kyvos/app/kyvos/postgres/lib

  • When upgrading, if the database backup has already been taken, a dialog will appear on the Upgrade screen prompting you to select the following checkboxes.

  • After selecting the appropriate checkboxes, enter your Kyvos Manager password. See the Upgrading Kyvos section for more details.

    • Click Upgrade

    , 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.

      Image Added

    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 as mentioned above.

      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==

  • Create Azure Postgres SQL Database.

  • Take the restored DelveRepo backup (created before upgrade) and restore it in the newly created PostgreSQL database (created in step 1).

    • To do this, do one of the following:
    Execute the following command:
    kyvos/postgres/bin/pg_restore -c -C "host=localhost port=45421 dbname=delverepo user=postgres password=PROVIDE-ACTUAL_PWD" > data_backup.sql

    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.

    Image Added

    1. To restore database dump, execute the following command
      ./psql -U ${user} -h ${hostname} -f ${filename}

      For example,
      ./pg_restore -c -C "host=psql -U postgres -h kyvos-postgresserver-101063058.postgres.database.azure.com port=5432 dbname=delverepo user=postgres@kyvos-postgresserver-1010 password=delve@123" delverepo_backup.sql -f databasedump
      -or-

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

        Image Added

      2. Provide the details for newly created repository database Server Name details in which the dump is importedrestored, and then click Fetch details.

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

    ...