Versions Compared

Key

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

Applies to: (tick) Kyvos Enterprise  (tick) Kyvos Cloud (SaaS on AWS) (error) Kyvos AWS Marketplace

...

  • You can see the last operation details, including progress status and start time, by clicking the i icon. To view more comprehensive details, simply click the View Details link, which will take you to the Operations page, where you can view the operation information in detail. 

  • To avoid semantic model data loss, ensure that before switching ensure property “OBSOLETE_CUBE_PURGE_FREQUENCY“ is set in olapengine.properties by increasing the value for it to desired frequency value in which verification that switching worked well can be complete.

  • If the target repository password is different then only for connection testing purposes password can be specified in provided optional input. If not specified explicitly, Kyvos Manager will use the existing password configured in the system for validating the connection. This is not applicable to GCP.

  • Before switching the repository ensure that you have data ready in the target Postgres instance to which you are switching.

  • Dump import and export can be done using pgdump and psql. However, in case of external to external repository change service on the snapshot offered by the cloud can be used to take snapshot from source Postgres and restore it in destination Postgres.

  • Username and Password and database name in target Postgres instance to which switching to is expected to be same as that of current in-use Postgres instance.

  • Rollback Scenario: If after an upgrade, the repository is switched then before performing rolling back, ensure it is switched back to the original repository.

  • For Azure, the Postgres port is fixed (5432) and cannot be specified manually.

  • Permissions required in role Permissions required in role attached on Kyvos Manager node remains same as that of required for automated deployed in case of external repository thus for switching from external repository to external repository no additional permission is required in the role added on Kyvos Manager node.

  • For switching from bundled to an external repository, you need to add permission on the role attached to the Kyvos Manager node so that fetch or external repository details work. If permission is not added to the role, then the Fetch Details will not work. However, you can still proceed ahead by providing those details manually on provided UI inputs.

  • If switching to an external repository, then proper network access should be configured.

  • The security group must have a role granting access to the port used by external repo from BI Server and Kyvos Manager node if it is in the same region and resource group (For Azure Postgres) as that of the cluster.

  • Following tags are expected on the external repository:

    • UsedBy - Kyvos

    • ROLE - DATABASE

    • LAYER - Metadata_Storage

Using Database

...

import/export commands
Anchor
commands
commands
Anchor
export-importcommands
export-importcommands

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note:

Database name is fixed and always required as delverepo.

For import and export, run the below commands from kyvos/Postgres/bin folder of Kyvos Manager machine.

...

Code Block
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:{KYVOS_HOME}/Postgres/lib:{KYVOS_HOME}/Postgres/librhel8
./psql -h <HOST-NAME> -p <PORT> -U <USER-NAME>

...

Database dump Import

Before importing, if the database dump itself doesn't take care of creating database then ensure you have manually create database first using create database command

...

The following tables describes the sample commands. This is ONLY for reference.

Repository

Sample command (for Kyvos database ONLY)

Import to bundled

./psql -U postgres -p 45421 -h localhost -d delverepo -f db-dump.sql

Import to external 

AWS:
./psql -U postgres -p <> -h <> -d delverepo -f db-dump.sql
Azure:
./psql -U postgres -p 5432 -h kyvos-postgresserver-1010.postgres.database.azure.com -d delverepo -f db-dump.sql
GCP:
<>

...

./psql -U postgres -p 5432 -h 10.243.140.5 -d delverepo -f db-dump.sql

Database dump export

Code Block
./pg_dump -c -C --host=<host> --port=<port> --dbname=<database name> --user=<user name> --password=<password> <file name>

The following tables describes the sample commands. This is ONLY for reference.

Repository

Sample command (for Kyvos database ONLY)

Export from bundled

./pg_dump -c -C --host=localhost --port=45421 --dbname=delverepo --user=postgres --password=<password> dbdump.sql

Export from external 

AWS:
./pg_dump -c -C --host=<RDS endpoint> --port=45421 --dbname=delverepo --user=postgres --password=<password> dbdump.sql

Azure:
./pg_dump -c -C --host=kyvos-postgresserver-1010.postgres.database.azure.com --port=5432 --dbname=delverepo --user=postgres --password=<password> dbdump.sql

GCP:

Switching repository

The section provides information on the following:

...

Switching from bundled repository to external repository

./pg_dump -c -C "host=10.123.230.22 port=5432 dbname=delverepo user=postgres password=<passwd>" > dbdump.sql

Switching repository

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

Currently, in AWS, the switch repository is not working as expected; therefore, migrating a repository is not supported.

In the Kyvos 2025.2 release, following switching repository cases not supported:

  • Switching from an external repository to bundled repository

  • Switching from external repository to another external repository

The section provides information on the following:

Switching from an external repository to bundled repository
Anchor
exttobundled
exttobundled

  1. Export data from external Postgres (AWS RDS or , Azure Postgres or GCP CloudSQL).

  2. In an existing cluster, identify the target node for running bundled Postgres and start the Postgres service on that target node.

  3. On the navigation bar, click Utilities > Manage Kyvos Repository.

  4. On the Manage Kyvos Repository page, select the Bundled Postgres Repository option (by default, Bundled Postgres will be shown selected).

  5. Select that cluster node from the dropdown on which the data dump is imported in step #2 above.

  6. If needed, select the Restore Database Dump option to restore a dump of the Postgres database.

    1. Locate Dump data from:

      1. Restore data from last backup:Select this option to get the data restored from the last created backup.

      2. Upload data dump file: Select this option to upload a previously saved data dump file.

  7. Perform repository connection validation using Test Connection link.
    NOTE: In case of any problem with the test connection, you will see an error message. Fix those problems before proceeding with switching the repository.

  8. Once the connection is validated successfully, click the Save button. This will configure new Postgres as a repository for Kyvos.

  9. Restart the BI Server service.

...

Aura tab collection
paramsJTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlN0QlMkMlMjJhY3RpdmUlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzZjU4MjI3JTIyJTdEJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSUyMiUyM2RmZTFlNiUyMiU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIyY29sb3IlMjIlM0ElMjIlMjM1ZTZjODQlMjIlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSUyMiUyMzVlNmM4NCUyMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJ3aWR0aCUyMiUzQTElMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyM2NjY2VjZiUyMiU3RCU3RCU3RCU3RA==
Aura tab
summaryAWS
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBV1MlMjAlMjIlN0Q=
Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

The IAM permissions must be required to fetch repository details.

  1. Enter the Repository Identifier, e.g. kyvosmanager-repo-database-ms24apr.
    Note that the DB Identifier is the same as the Repository Identifier. Copy the DB Identifier value and paste it in the Repository Identifier section.

    image-20240603-115635.png
  2. Click Fetch Details. The information for RDS Endpoint, Port, and Version is autopopulated by default for the target external repository.

    image-20240603-120528.png
Aura tab
summaryAzure
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMiU3RA==
Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

No additional permission is required to fetch details unless the repository is in the same resource group as the Kyvos Manager machine. It is recommended that the repo should be kept in the same region.

  1. Enter the Server Name, e.g. kyvos-postgresserver-85930
    Note that the Azure Database name is the same as the Server name. Copy the Azure Database name value and paste it in the Server name field.

    image-20240603-121456.png
  2. Click Fetch Details. The information for Database Node, Port, and Version is auto-populated by default for the target external repository.

    image-20240603-132440.png

Aura tab
summaryGCP
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJHQ1AlMjIlN0Q=
  1. Enter the Server name. e.g. kyvos-postgresserver-22299
    Note that the SQL Instance Type is the same as the Server name.

  2. Login to GCP Console.

  3. Search for SQL Instance. In the Instances section, copy the instance Type as Postgres. The version must be 13supported version of Postgres is13.

    CloudSQL.png
  4. Click Fetch Details. The information for Database Node, Port, and Version is auto-populated by default for the target external repository.
    NOTE: The automatic start or stop of external repository is not supported.

    image-20250218-074307.png

...

JTdCJTIydGl0bGUlMjIlM0ElMjJHQ1AlMjIlN0Q=
  1. NOTE: The automatic start or stop of repository is not supported.

    image-20250218-074307.pngImage Added
Aura tab collection
paramsJTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlN0QlMkMlMjJhY3RpdmUlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzZjU4MjI3JTIyJTdEJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSUyMiUyM2RmZTFlNiUyMiU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIyY29sb3IlMjIlM0ElMjIlMjM1ZTZjODQlMjIlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSUyMiUyMzVlNmM4NCUyMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJ3aWR0aCUyMiUzQTElMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyM2NjY2VjZiUyMiU3RCU3RCU3RCU3RA==
Aura tab
summaryAWS
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBV1MlMjAlMjIlN0Q=
Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

The IAM permissions must be required to fetch repository details.

  1. Enter the Repository Identifier, e.g. kyvosmanager-repo-database-ms24apr.
    Note that the DB Identifier is the same as the Repository Identifier. Copy the DB Identifier value and paste it in the Repository Identifier section.

    image-20240603-115635.png
  2. Click Fetch Details. The information for RDS Endpoint, Port, and Version is autopopulated by default for the target external repository.

    image-20240603-120528.png
Aura tab
summaryAzure
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMiU3RA==
Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

No additional permission is required to fetch details unless the repository is in the same resource group as the Kyvos Manager machine. It is recommended that the repo should be kept in the same region.

Enter the Server Name,

unless the repository is in the same resource group as the Kyvos Manager machine. It is recommended that the repo should be kept in the same region.

  1. Enter the Server Name, e.g. kyvos-postgresserver-85930
    Note that the Azure Database name is the same as the Server name. Copy the Azure Database name value and paste it in the Server name field.

    image-20240603-121456.pngImage Added
  2. Click Fetch Details. The information for Database Node, Port, and Version is auto-populated by default for the target external repository.

    image-20240603-132506.pngImage Added

Aura tab
summaryGCP
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJHQ1AlMjIlN0Q=

  1. Enter the Server name. e.g. kyvos-postgresserver-8593022299
    Note that the Azure Database name is the same as the Server name. Copy the Azure Database name value and paste it in the Server name field.

    image-20240603-121456.pngImage Removed

    the SQL Instance Type is the same as the Server name.

  2. Login to GCP Console.

  3. Search for SQL Instance. In the Instances section, copy the instance Type as Postgres. The supported version of Postgres is13.

    CloudSQL.pngImage Added
  4. Click Fetch Details. The information for Database Node, Port, and Version is auto-populated by default for the target external repository.

    image-20240603-132506.pngImage Removed
Aura tab
summaryGCP
params
  1. Perform repository connection validation using Test Connection link.
    NOTE: In case of any problem with the test connection, you will see an error message. Fix those problems before proceeding with switching the repository.

  2. Once the connection is validated successfully, click the Save button. This will configure a new Postgres as a repository for Kyvos.

  3. Restart the BI Server service.

...