/
Validating Kyvos resources for Google Cloud Platform
Document toolboxDocument toolbox

Validating Kyvos resources for Google Cloud Platform

Owned by Sarabjeet Kaur
Last updated: Nov 15, 2024
2 min read

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

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

To manually validate the Kyvos resource, perform the following steps.

  1. Download the env-validation.jar file.

  2. If you are running validation from a non-GCP machine, ensure that the nodes are reachable and provide your Service Account credential key using the command
    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"
    Refer to Google documentation for details. 

  3. Create a properties file having the following parameters:  
    With Deployment Name
    If resources are available in the deployment:

Parameter

Description

Parameter

Description

stackName

Name of your GCP deployment

projectName

Name of the project in which Kyvos GCP deployment is available

privateKey

The absolute path of the private key for Kyvos instances

username

Credentials of the user for SSH on the Kyvos instances

license

The absolute path of OLAP engine license file

useSSHForComputeCluster

true/false

region

Deployment region

dataprocprivatekeypath

The absolute path of Dataproc private key

Without Deployment Name
If your resources are not available in the deployment:

Parameter

Description

Parameter

Description

biMachineName

Comma-separated list of BI Server machines

qeMachineName

Comma-separated list of query engine machines

zone

deployment zone

dataprocclustername

name of the Dataproc cluster used with Kyvos

dataprocclusterregion

Dataproc cluster region

cloudfunction

The function being used for cluster scheduling

subnetwork

subnetwork in which the resources are created

subnetworkRegion

name of the sub network region

vpcProjectId

Project ID of the project in which your VPC is present

bucketName

bucket name for use with Kyvos

  1. If a password is used for node validation, enable password authentication on each BI Server, Query Engine, and Kyvos Manager node. 

    Refer to the following combination of keys in the properties file:

Key name  

Description  

Key name  

Description  

serviceAccount(GCP) 

This key is required to specify the service account associated with Kyvos.

secretName (GCP) 

Required in the init conf file if an external secret is used. In case of secret exist in deployment, the password is read from the secret used in deployment.

kyvosnodespassword(GCP) 

Required in init conf file if plain text password or encrypted password is used to validate nodes. If cryptography_algorithm key is present in init conf file this value is treated as encrypted else, this is treated as plain text.

cryptography_algorithm(GCP) 

Required in init conf file if validation needs to perform on encrypted password. kyvosnodespassword key should be encrypted.

  1. Run the command:  

    <KM install path>/kyvosmanager_war/kyvosmanager/jre/bin/java -cp <path>/env-validation*.jar com.kyvos.cloud.validators.EnvironmentValidationInitiator <KM install path>/kyvosmanager_war/kyvosmanagerdata/server/repo/metadata.Kyvos/metadata.Validations/gcp/ <path>/gcp.properties gcp

  2. Validation will create/update the following two files:

    1. environmentvalidation.log  - contains detailed validation logs

    2. environmentvalidationsummary.info  - contains validation summary

  3. Verify the summary to ensure there are no errors.

Copyright Kyvos, Inc. All rights reserved.