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

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

Currently, environment validation functionality can be used/triggered in two ways:

1. Using automated deployment in which environment validation is automatically performed by Kyvos Manager just before starting the cluster deployment provided the user has opted for environment validation.

2. Using standalone validation capability.  

For performing environment validation during automated deployment, there is no change or additional input provided/required in the resource creation wizard (I want to create resources) of Kyvos Manager. Preference, whether to perform environment validation during automated deployment or not, is completely governed by a parameter (flag) in the deployment template. If in that parameter user requests to perform environment validation, then environment validation is performed just before starting automated cluster deployment. When environment validation is requested and if the environment validation fails, then the cluster deployment is not started. If environment validation is not requested, then environment validation is skipped and the cluster deployment is started directly.  

Standalone environment validation always needs to be initiated by the user. This can be performed by executing a command and passing a few arguments (path of metadata folder/files and environment information file) into it. Details of exact commands and arguments are given in the steps below. One of the arguments is the path to the environment information details file. The environment details file is a property file that expects configuration values of the environment to be provided as a key-value pair in the property file. 

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

1. Download the env-validation.jar file.

   • Kyvos 2025.4.1 env-validation.jar file

   • Kyvos 2025.4 env-validation.jar file

2. If you are running validation from a non-Azure machine, Validate node reachability.

3. Create file ${USER_HOME}/.azure/azureauth.properties with the following properties:

   • AZURE_CLIENT_ID= Client ID

   • AZURE_TENANT_ID= Tenant ID

   • AZURE_SUBSCRIPTION_ID= Subscription ID

   • AZURE_CLIENT_SECRET= Client secret

4. Create a properties file, having the following parameters:
   

Parameter Description stackName Name of your Azure deployment databricksUrl Databricks cluster URL keyVaultURL Azure Key Vault URL abfsAccountName Storage account name bucketName Bucket name in Storage account   resourceGroupName Resource group name where resources exist subscriptionId Subscription ID username Username to connect nodes privateKey Private key file path license Kyvos BI Server License key file path networkResourceGroupName Virtual network resource group name databricksVirtualNetworkName Databricks cluster virtual network name clientId Client ID of Managed identity assigned to the Kyvos Manager machine   databricksClusterId Databricks cluster ID orgId Databricks cluster organization ID computeClusterAuthType MANAGED_IDENTITY   tenantId Tenant ID of Azure resources Note You can find the values for these parameters in the AZURE.init.conf file at /data/kyvos/install/kyvosmanager_war/kyvosmanager/conf location or check your Azure portal to get details of resources. Parameter Description databricksUrl Databricks cluster URL keyVaultURL Azure Key Vault URL abfsAccountName Storage account name bucketName Bucket name in Storage account   resourceGroupName Resource group name where resources exist subscriptionId Subscription ID username Username to connect nodes privateKey Private key file path license Kyvos BI Server License key file path networkResourceGroupName Virtual network resource group name databricksVirtualNetworkName Databricks cluster virtual network name dbIdentifier Azure Postgres Database name   biMachineName Machine name of the BI Server VM databricksClusterId Databricks cluster ID qeScaleSetName Query engines scale set name virtualNetworkName Virtual Netw ork name vmSubnetName Subnet name clientId Client ID of Managed identity assigned to the Kyvos Manager machine   databricksClusterId Databricks cluster ID orgId Databricks cluster organization ID computeClusterAuthType MANAGED_IDENTITY   tenantId Tenant ID of Azure resources Note You can find the values for these parameters in AZURE.init.conf file at /data/kyvos/install/kyvosmanager_war/kyvosmanager/conf location or check your Azure portal to get details of resources.

5. 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/azure/ <path>/azure.properties azure > validation.out 2>&1

6. Verify the following log files generated in the same folder where validation jar is executed.

   1. environmentvalidation.log

   2. environmentvalidationsummary.info

   3. validation.out