Deploying Kyvos Resources on GCP using Kyvos Manager

Cluster Name

Provide a name for your cluster.

License

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

Installation Path

Provide the installation path to deploy Kyvos.

Node Authentication

User Name

Enter username with sufficient rights to deploy cluster.

Authentication Type

Select one of the following:

• 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. For more details, see the

  “links” section on this page.

Configure Kyvos Services on Cloud

Select Instance by

Select one of the following:

• 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 Analytical 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.

Fetch resources: Click the link then secrets list will be based on the currently selected project. To use different project, you can change the project for secrets.

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

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

By default, this checkbox is not selected.

• Case 1: For Single Node Standard (SNS) deployment, select this checkbox to deploy Single Node Standard (SNS). After selecting this checkbox, the options to deploy instances for Analytical Server, instances for Query Engine, and instances for Web Portal will be disabled.

• Case 2: For multi-node deployment, do not select this checkbox. The options to specify instances for Analytical Server, instances for Query Engine, and instances for Web Portal will be enabled.

Instance(s) for Analytical Server

Instance(s) for Analytical Server

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

Note: If you have the compute.regions.list permission, the instance selection list appears. Otherwise, you must enter it manually in the text box.

Instance(s) for Query Engine

Instance(s) for Query Engine

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

Note: If you have the compute.regions.list permission, the instance selection list appears. Otherwise, you must enter it manually in the text box.

Instance(s) for Web Portal

Instance(s) for Web Portal

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

Note: If you have the compute.regions.list permission, the instance selection list appears. Otherwise, you must enter it manually in the text box.

Virtual IP/Hostname

Virtual IP/Hostname

By default, this parameter is disabled. This field is displayed only when you have opted for multiple Web Portal.

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

Note: 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

Enable Kyvos Manager High Availability

By default, this checkbox is disabled. This is enabled only when multiple Web Portal instances are opted in the Instance(s) for Web Portal parameter.

Load Balancer Configuration

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.

• Show Status: Click this link to view the status.

• Validate again: To validate backend group details associated with Load Balancer.

Kyvos Repository

Kyvos Repository

Select the repository configuration required for your Kyvos deployment. The available options depend on whether you use a Kyvos Managed, Cloud SQL, or externally managed repository.

• Kyvos Repository: Select or search for the instance type to use for the repository.

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

If you select Cloud SQL, the following option is available:

• Automatically Start or Stop Repository: Select this checkbox to automatically start or stop the repository according to the configured schedule.
  Note:

  • You can enable this option later from the Manage Kyvos Repository page if it was not selected during deployment.

  • The list displays the repository used by Kyvos Manager.

• Repository User Name: Enter the Kyvos Database user name to access the repository.

  Note: External repository username is required only when you deploy with Cloud SQL.

• Repository Password: In case of CloudSQL, the following options are displayed.

  • Read password from Secret: Select this option to read the password from existing Secret Manager. If you select this option, the Enable the option to change repository passwords in Kyvos Manager after deployment is displayed. Select this option to change the Kyvos repository password from Kyvos Manager after the cluster deployment.

  • Enter Manually: Enter your Kyvos external repository password.

If you select an externally managed repository during the Kyvos Manager installation, configure the following details:

• Endpoint: Enter the repository endpoint.

• Port: Enter the repository port.

• User Name: Enter the repository user name.

• Password Source: Select the required password source:

  1. Enter a new password and save it.

  2. Use an existing password from a configured secret.

Note: When configuring either password option, select Enable the option to change repository password in Kyvos Manager after deployment to allow Kyvos Manager to change the repository password after deployment.

If Install Postgres as a Service is selected during Kyvos Manager installation, the Kyvos Managed repository option is displayed.

1. Enter the repository password in Password.

2. Enter the password again in Confirm Password.

Secrets Manager

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.

Output Storage 

Bucket Name

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

Compute Cluster Type

Compute Cluster Type

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

• For Shared Query Engine: Selecting this option will display the Enable External Metastore checkbox. Enter the thrift URL.

• For Dedicated Compute: Selecting this option will display the Instance Group and max Instance Count.

Dedicated Compute 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.

• Enable Compute Server Scaling: Select this checkbox to enable minimum or maximum or compute server for scaling. When you select this checkbox, the following options will be displayed.

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

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

• Node Count: Set the maximum instances allowed in the selected Instance Group. Changing the max node count affects the node count used by already-scheduled semantic model processing jobs.

Note: Compute server scaling will be disabled if this checkbox is not selected.

Function Configuration

Function Configuration

Select the required function from the list:

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

  • Cluster Scaling Schedule: Enter the name of the Cloud Scheduler job configured to trigger the cluster scaling function. For example, kyvos-clusterStartCloudScheduler-11962

  • Cluster Status: Enter the name of the Cloud Function used to retrieve the cluster status. For example, kyvos-clusterstartfunction-23081

• None: Select this option if you do not want to use scheduling.

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 , query engine, repository, and web portal services, in case any of these services go down

BI Server

Listener Port

Enter the listener port for Analytical Server.

JMX Port

Enter the JMX port for Analytical Server health monitoring.

Work Directory

Enter the directory location on HDFS, where Analytical 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 Analytical 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 Analytical 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: