Cluster Name

Provide a name for your cluster.

License

Click the Choose File button to select the license file and then click Upload.

Installation Path

Provide the installation path to deploy Kyvos.

User Name

Username with sufficient rights to deploy cluster.

Authentication Type

• Private Key: Choose and Upload the Private Key file.

• Password: Provide your credentials.

  NOTE: To use password authentication for instances while deployment, ensure that the instances have been configured for using Password-based authentication.

Select Instance by

• IP Address: Select this option for IP-based deployment.

• Hostname:  Select this option for hostname-based deployment. In this case, you can deploy the cluster using custom hostnames for nodes to be used for Kyvos services. 

  • Click the Use custom hostname for selected nodes link to specify or map custom hostname for selected BI Server, Query Engine, and Kyvos Manager/repository node.
    NOTE: Ensure that the instances have been configured for using Custom hostnames.

Project

Select your GCP project where your resources/deployment is present.

Deployment

Select the None option (node mapping manually).

Click the Refresh deployment resources link to get a list of resources available for your user credentials.

Deploy BI Server, Query Engine, and Web Portal Kyvos Services on <IP address> instances

This checkbox is displayed only when you select the  None (node mapping Manually)  option. 

NOTE: By default, the option to deploy instances for BI Server, instances for Query Engine, and instances for Web Portal will be disabled. 

Instance(s) for BI Server

Select the instances that you want to use for the BI Server. Optionally, you can also search the instance with its name.

Instance(s) for Query Engine

Select the instances that you want to use for the Query Engines. Optionally, you can also search the instance with its name.

Instance(s) for Web Portal

Select the instances that you want to use for the Web Portal. Optionally, you can also search the instance with its name.

Virtual IP/Hostname

Provide Virtual IP/Hostname in protocol://host:port format.

For cloud clusters, provide the endpoint information of Load Balancer. If protocol and port are not specified, they will be picked from the Kyvos Web Portal URL.

Enable Kyvos Manager High Availability

Select this checkbox to deploy Kyvos Manager High Availability (HA) enabled cluster. This is enabled only when multiple Web Portal based deployment is opted.

Load Balancer Configuration

Select the Configuration for Web Portal and Configuration for Kyvos Manager checkboxes.

• Configuration for Web Portal: Enter the Instance Group name.

• Configuration for Kyvos Manager: Enter the Instance Group name.

• To view the status, click Show Status. To validate backend group details associated with Load Balancer, click Validate again.

Kyvos Repository

Select the instances that you want to use for the Kyvos repository. Optionally, you can also search the instance with its name.

• Check selected nodes status: Click this link to verify the status of the selected node.

NOTE: From Kyvos 2025.2 onwards, for Kyvos Manager and Kyvos must have different external CloudSQL repository.

Repository Password

Provide the password for repository authentication.

Secrets Manager

• Project: Enter your project name where your secrets are created.

• Secrets: enter or select your secrets name in which you want to store passwords.

NOTE: This option is available only for account-based resources deployments, which means if you selected the None option in the Deployment list and click the Fetch resources link then secrets list will be based on the currently selected project. To use different project, you can change the project for secrets.

Output Storage Bucket Name

Provide the name of the bucket where Kyvos semantic models will be stored.

SSH Preference

Select the checkbox to use SSH for connecting with Dataproc Cluster Master Node.
NOTE:

• If you do not select this option, you will need to perform manual steps later, in case you need to perform any sync operations from the Kyvos Manager.

• This option will be displayed only when you select “Dataproc” as a compute cluster

User Name

User having requisite permissions for cluster deployment.
NOTE: This option is displayed only if you have selected the SSH Preference option.

Use different private key for Dataproc nodes authentication

Select this option to use a different private key for nodes' authentication.
NOTE: This option is displayed only if you have selected the SSH Preference option.

Compute Cluster Type

Select Shared Query Engine, Kubernetes, or Dedicated Compute from the list.

NOTE:

• When you select Kubernetes from the Compute Cluster Type list, the Kubernetes Details section is displayed.

• Selecting the Dedicated Compute from the Compute Cluster Type list will display the Instance Group and max Instance Count.

Kubernetes Details

Enter the following Kubernetes details:

• Kubernetes Cluster Name: Select the Kubernetes cluster name from the list.

• Node Pool Name: Select the Node Pool name from the list.

• Validate Kubernetes Cluster Details: Click this link to validate Kubernetes cluster details.

Dedicated Compute Details

Enter the following Dedicated Compute details:

• Instance Group: Select the required instance group to be used as a dedicated compute cluster.

• Min Instance Count: Enter number of minimum instances count for instance group.

• Max Instance Count: Enter number of maximum instances count for instance group.

Enable Compute Server Scaling

Select this checkbox to enable maximum or minimum compute server for scaling. When you select this checkbox, the following options will be displayed.

• Minimum Compute Server Count: Select the minimum compute Server count that will be started initially.

• Maximum Compute Server Count: Select the maximum compute Server count up to which you want to scale.

NOTE: If you do not select this checkbox, the Compute Server Count field is displayed. Compute server scaling will be disabled if this checkbox is not selected.

Function Configuration

Select the required function from the list:

• Using the Function Name: The Cluster Scaling Schedule, Cluster Status, and BI Server Start fields are displayed.

  • Cluster Scaling Schedule

  • Cluster Status

  • BI Server Start

• Using Stack Name: The Function Deployment field is displayed.

  • Function Deployment: Provide the name of the deployment where your Google Deployment Functions are deployed.

• None: Selecting this option will display an error message. You must specify the Function Deployment name as this is mandatory for Kyvos scaling feature.

Common

Kyvos Setup Package

Select the Kyvos bundle to be installed. Kyvos Manager contains compatible Kyvos bundles. To use any other Kyvos version, click the Upload button

Semantic Model Local Path

Enter the semantic model local path where cuboids will be copied. For multiple paths, enter a semicolon-separated list.
NOTE: The deployment user must have full permission on the parent of the local semantic model path.

Automatically restart Kyvos services when down

Select this option to enable high availability mode for the Kyvos service. This will ensure Kyvos services are always up and running. The Kyvos Manager will automatically restart the BI server, query engine, repository, and web portal services, in case any of these services go down

BI Server

Listener Port

Enter the listener port for BI Server.

JMX Port

Enter the JMX port for BI Server health monitoring.

Work Directory

Enter the directory location on HDFS, where BI Server has access permissions.

Memory Configuration Mode

By default, the Auto mode is selected. In Auto Mode, calculations are performed automatically by the system internally.
In Manual Mode, you can manually provide memory values as needed.
NOTE: The Maximum Heap Memory and Analytical Store Max Memory options are enabled only when you set the memory configuration in the Manual mode.

Maximum Heap Memory

Enter the maximum memory available for BI Server.

Analytical Store Max Memory

Specify analytical store max memory for querying in GB.

Additional Java Options

Use this to define custom Java properties for your BI Server.

Query Engine

Thrift Listener Port

Enter the thrift listener port for Query Engine.

JMX Port

Enter the port for Query Engine health monitoring.

Memory Configuration Mode

By default, the Auto mode is selected. In Auto Mode, calculations are performed automatically by the system internally. In the Manual Mode, you can manually provide memory values as needed.

NOTE:

• The Maximum Heap Memory, Analytical Store Max Memory for Querying, Analytical Store Max Memory for Processing, and Configure Concurrent Processing Task options are enabled only when you set the memory configuration in the Manual mode.

• If you set the memory configuration in the Manual mode, the Configure Concurrent Processing Task option can be enabled as Auto or Manual as needed.

Maximum Heap Memory

Enter the maximum memory for Query Engine.

Analytical Store Max Memory for Querying

Specify analytical store max memory for querying in GB.

Analytical Store Max Memory for Processing

Specify analytical store max memory for processing in GB.

Configure Concurrent Processing Task Count

By default, the Auto mode is selected.

If you select the Manual mode, specify the number of nodes to be used for concurrent processing task count.

Additional Java Options

Use this to define custom Java properties for your Query Engine.

Web Portal

UI Port

Enter the port on which Kyvos Web client will run.

JMX Port

Enter the port for Web portal health monitoring.

Shut-down Port

Enter the port to be used for shutting the Tomcat server.

AJP Port

Enter the port on which the AJP connector creates a socket and awaits an incoming connection.

Maximum Heap Memory

Enter the maximum memory for the Web portal.

Additional Java Options

Use this to define custom Java properties for the Web portal.

Network Protocol Configuration

Enable TLS

Select the checkbox to enable TLS for the cluster.

HTTP Protocol Version

Select the HTTP Protocol Version for use with TLS.

Kyvos Web Portal on HTTPS

Select the checkbox to use HTTPS for connecting to Kyvos Web Portal.

Kyvos Web Portal Configuration

NOTE: This is displayed only if Kyvos Web Portal on HTTPS checkbox is selected

• Certification Mode: Select the Use Path or Upload File option.

• Keystore: Provide the path or upload the Keystore file for the certificate.

• Keystore Private Key: Provide the Keystore Private Key for the certificate.

• Custom Attributes for Connectors: If needed, provide attributes to be used for the HTTPS connector.

  To update any fields, enter information as: