VCS Configuration¶

The Solution Manager allows you to save a backup of the state of the Denodo servers after a deployment, on a Version Control System (VCS). The backup will be performed both for successful and unsuccessful deployments.

On the one hand, the Solution Manager generates a backup for the Virtual DataPort servers. It accesses to the first Virtual DataPort server of the environment, following the order defined in the catalog tree, and executes DESC VQL DATABASE. This backup consists of the server catalog (views, data sources, web services, etc.) expressed as a list of VQL sentences.

On the other hand, the Solution Manager generates a backup for the Scheduler servers, using the information of the first Scheduler server of the environment. This backup includes a zip file with the server metadata (jobs, data sources, etc.).

The Solution Manager also allows to do a rollback after a failed deployment, to restore the previous state of the first Virtual DataPort and Scheduler server that is enabled on each enabled cluster of the environment. To do this, the Solution Manager imports a VQL file into these Virtual DataPort servers and a zip file with the Scheduler metadata into the first Scheduler server that is enabled on each enabled cluster.

Solution Manager performs the changes inside a transaction, so the rollback process importing metadata is not needed.

To configure your VCS repository (Version Control System) for backups, click the menu Configuration > Version Control System.

VCS configuration panel¶

Follow these steps to connect to Git using SSH keys authentication:

1. Log in to the computer where the Solution Manager is running, with the same user account you use to start the Solution Manager.

2. In this computer, check that the Git server is in the “known hosts” file of this computer (usually located in $HOME/.ssh/known_hosts on Linux and %USERPROFILE%\.ssh\known_hosts on Windows). If this file does not exist or does not contain an entry for the Git server, run this command:

   ssh -o HostKeyAlgorithms=ecdsa-sha2-nistp256,ssh-ed25519,ssh-rsa,ssh-dss <host name of the Git server>
   

3. Execute the command below to generate an SSH key pair using the Ed25519 algorithm. The keys cannot have passphrase.

   ssh-keygen -t ed25519 -C "your_email@example.com"
   

   Note

   If you are using a legacy system that does not support the Ed25519 algorithm, use:

   ssh-keygen -t rsa-sha2-256 -C "<your.email@example.com>" -b 4096 -m PEM
   

4. The previous step generates two files in the .ssh directory of your home directory: id_rsa (the private key) and id_rsa.pub (the public key).

5. Upload the public key (id_rsa.pub) to the Git server. The administrator of this Git repository will be able to help you to do this.

Provide the following information:

• Version Control System: The Solution Manager supports GIT and Subversion as VCS for backups.

• URL: Remote location of the VCS repository.

• Use default branch: For Git repositories, you can choose if you want to use the default remote branch or not.

• Branch: Name of the branch to use for the backup, when Use default branch is disabled.

• VDP backup max file size (MB): Split VDP backup files before uploading them to the Git repository. It must define the size at which the VDP backup file will be chunked, to perform backups of Denodo environments in Git repositories that do not support file sizes larger than 100 MB. Values that activate file splitting are integers between 1 and 100 MB.

• User/password authentication: Enable this option if your VCS repository requires authentication with user and password.

• User: User name to connect to your VCS repository, when User/password authentication is enabled.

• Password: Password to connect to your VCS repository, when User/password authentication is enabled.

• Local repository home: Leave the default value. Folder in the file system of the Solution Manager where the local copy of the remote repository resides.

• VCS local temporary directory name: Leave the default value. Folder name in the working directory used for the local temporary copy of the repository.

• Upload waiting time (ms): Wait time between failed upload attempts to the repository.

• Upload attempts: Maximum number of retries of upload operations to the repository.

Click to save the changes.

Once you set this up, change the configuration of the environments so the Solution Manager stores a backup on the VCS after deploying a revision to that environment. To enable this on an environment, open its configuration and select Save VCS backup when the deployment finishes.