Versions Compared

Key

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

Applies to: Image Removed Kyvos Enterprise   Image Removed Kyvos Cloud (Managed Services on AWS)    Image Removed Kyvos Azure Marketplace

Image Removed Kyvos AWS Marketplace    Image Removed Kyvos Single Node Installation (Kyvos SNI)     Image Removed Kyvos Free (Limited offering for AWSApplies to: (tick) Kyvos Enterprise  (tick) Kyvos Cloud (SaaS on AWS) (error) Kyvos AWS Marketplace

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

...

For Azure, when using an external repository as the Kyvos repository, it is important to manually back up the Kyvos external repository instance before upgrading. This will help avoid any compatibility issues during rollback. 

Managing Kyvos external repository for AWS 

...

Info
  • From Kyvos 2023.2 onwards, the backup process of the Kyvos external repository RDS has been automated during the upgrade. Similarly, the Kyvos external repository RDS restoration process has been automated during the rollback.

  • If the automated backup

    and

    during upgrade or restoration process fails during rollback, you

    should

    must resume the steps from the point where it stopped previously. To do this, you must follow the manual steps as mentioned below.

Aura tab collection
settings{"generalSettings":{"tabSpacing":0,"tabWidth":100,"tabHeight":45,"direction":"horizontal"},"activeSettings":{"backgroundColor":{"color":"#f58227"},"text":{"fontSize":14,"color":"#000000","textAlign":"left","fontWeight":"bold"}},"inactiveSettings":{"backgroundColor":{"color":"#e2e2e2"},"text":{"fontSize":14,"color":"#000000","textAlign":"left","fontWeight":"bold"},"border":{"top":true,"left":true,"right":true,"bottom":true,"width":1,"style":"solid","color":"#cccecf"}},"contentSettings":{"backgroundColor":{"color":"#fff"},"padding":{"top":10,"right":10,"bottom":10,"left":10},"border":{"style":"solid","width":1,"top":true,"bottom":true,"left":true,"right":true,"color":"#cccecf"}},"hoverSettings":{"backgroundColor":{"color":"#cccecf"},"text":{"fontSize":14,"color":"#000000","textAlign":"left","fontWeight":"normal"}}}
tab1
Aura tab
titlePre-upgrade steps
Aura tab
titlePre-rollback steps

Managing Kyvos external repository for Azure

 Applies to: Image Removed Kyvos Enterprise   Image Removed Kyvos Azure Marketplace   Image Removed Kyvos Single Node Standard Installation

Aura tab collection
settings{"generalSettings":{"tabSpacing":0,"tabWidth":100,"tabHeight":45,"direction":"horizontal"},"activeSettings":{"backgroundColor":{"color":"#f58227"},"text":{"fontSize":14,"color":"#000000","textAlign":"left","fontWeight":"bold"}},"inactiveSettings":{"backgroundColor":{"color":"#e2e2e2"},"text":{"fontSize":14,"color":"#000000","textAlign":"left","fontWeight":"bold"},"border":{"top":true,"left":true,"right":true,"bottom":true,"width":1,"style":"solid","color":"#cccecf"}},"contentSettings":{"backgroundColor":{"color":"#fff"},"padding":{"top":10,"right":10,"bottom":10,"left":10},"border":{"style":"solid","width":1,"top":true,"bottom":true,"left":true,"right":true,"color":"#cccecf"}},"hoverSettings":{"backgroundColor":{"color":"#cccecf"},"text":{"fontSize":14,"color":"#000000","textAlign":"left","fontWeight":"normal"}}}
tab1
Aura tab
titlePre-upgrade steps
Aura tabtitlePre-rollback steps
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.

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.

Managing Kyvos external repository for Azure

For Azure, when using an external repository as the Kyvos repository, it is important to manually back up the Kyvos external repository instance before upgrading. This will help avoid any compatibility issues during rollback.

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
  1. Before upgrading the Kyvos version in cluster, you must export 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
    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.sq

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

  3. In 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

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

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

  6. Click Upgrade.

Aura tab
summaryAzure Postgres restore
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMFBvc3RncmVzJTIwcmVzdG9yZSUyMiU3RA==
  1. Create Azure Postgres SQL Database.

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

  3. 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
    For example,
    ./pg_restore -c -C "host=kyvos-postgresserver-1010.postgres.database.azure.com port=5432 dbname=delverepo user=postgres@kyvos-postgresserver-1010 password=delve@123" delverepo_backup.sql
    -or-

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

    2. Provide the details for newly created repository in which dump is imported, and then click Fetch details.

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