Installing Cluster using Account Resources Created on Azure Externally

Cluster Name

Provide a unique cluster name

License

Upload your Kyvos license file, and click UPLOAD

Installation Path

Provide the installation path for Kyvos

Node Authentication

User Name

Enter your username for authentication.

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.

Configure Kyvos Services on Cloud

Select Instance by

• IP Address: Select this option for IP Address-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 a custom hostname for the selected Analytical Server, Query Engine, and Kyvos Manager/repository node.
    NOTE: Ensure that the instances have been configured for using Custom hostnames.

Resource By

Select Deployment or Account as needed.

• For Deployment: Select the deployed stack from the list.

• For Account: Click the Fetch Resources link to get a list of externally created resources. The Deploy BI Server, Query Engine, and Web Portal services on ip-<> instance checkbox is displayed. This option appears only when you select the Account (node mapping Manually) option. Selecting it checkbox deploys Kyvos services on the same instance.

Resource Group Name

Enter the name of the resource group containing your resources.

Virtual machines for BI Server

Select the VMs to be used for Kyvos Analytical Server from the drop-down list.

Query Engine Scale Set

Select the scale set to be used for the Kyvos Query Engine scale set from the drop-down list.

Virtual Machines for Query Engine

Select the VMs to be used for the Kyvos Query Engine from the drop-down list.

Virtual machines for Web Portal

Provide a comma-separated list of IP Addresses/Hostnames for the VMs to be used as Web portal instances.

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 Application Gateway, Backend Pool name and Resource Group Name. The options will vary based on your selection.

• Configuration for Kyvos Manager: Enter Application Gateway, Backend Pool name and Resource Group Name. The options will vary based on your selection.

• Validate: Click this option to verify the details. The system will check for the details. If all the provided details are correct, you can continue with deployment. Else, you must re-verify the details.

Kyvos Repository

Shows the IP Address/Hostname of the Kyvos Manager node that will be used as the Kyvos Repository. 

Repository User Name

Enter the Kyvos Database user name to access the repository.

Repository Password

• Read 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 cluster deployment.

• Enter Manually: Enter your Kyvos external repository password.

NOTE: This option is available only when you select the None option from the Stack list. (Account Resources)

Compute Cluster

Compute Cluster Type

Select the Kubernetes, Shared Query Engines, or Dedicated Compute Cluster option.

Note:

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

• If Kubernetes is selected, you must have all the prerequisites/permissions specified on Azure Kubernetes Cluster Permissions.
  NOTE: If Kubernetes service is selected, the Kubernetes details section is displayed.

• Selecting the Dedicate Compute option will display the Scale Set, Min Instance Count, Max Instance Count, and Enable Compute Server Scaling checkbox options.

• Select Shared Query Engine

Kubernetes Details

Enter the following Kubernetes details:

• Kubernetes Cluster Name: Select the Kubernetes cluster name from the list. Click Fetch Details. The Kubernetes cluster details will be fetched.

• Shared Resources with Multiple Applications: Select the Is Shared Cluster checkbox, it will enable the Is Shared User Node Pool checkbox to use Kubernetes or User node pool as shared. If the Is Shared Cluster checkbox is selected, the Maximum Compute Server Count field will be disabled.

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

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

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

Proxy Server Configurations

Use Proxy Server to connect with Kubernetes Cluster

Select this checkbox if the direct communication between Analytical Server and Kubernetes cluster is restricted and needs a load balancer to route the calls

Namespaces

Enter the namespace in which the proxy server will be launched.

Node Pool Label

Enter the key and value of the node pool label, separated by a colon (i.e, key value).

System Node Pool Name

Select the system Node Pool name from the list.

User Node Pool Name:

Select the User Node Pool name from the list.
If the list is not populated, you need to enter the User Node Pool Name manually, and then click Validate Kubernetes Cluster Details to validate Kubernetes cluster details.

Managed Identity Client ID

Enter the managed identity client ID

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.

Compute Server Count

Enter compute server count.

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

Compute Namespace

Enter compute namespace.

Fetch Parameters

Clicking this will open a new dialog box where you need to provide the following details:

• fs.azure.account.auth.type: The OAuth input is displayed by default.

• fs.azure.account.oauth.provider.type: The input for this field is displayed by default.

• fs.azure.account.oauth2clientID: Enter the managed identity client ID.

• fs.azure.account.oauth2clientID: Enter the tenant ID.

Model Processing Orchestration

Orchestration by

Select one of the following options to configure target node for processing semantic model:

• Compute Master (Independent cluster)

• Analytical Server (Default)

Note:

• This feature is applicable only to Kubernetes-based compute servers with a configured proxy.

• The Compute Master must be in the same resource group as Kyvos.

Scale set

When the deployment type is selected as stack, enter the required scale set. If the deployment type is selected as None, the Scale Set list is displayed. Select the required scale set from the list.

Node Count

Enter the count of Compute Master instances.

Resource Group name

Enter the scale set resource group name for compute master.

Dedicated Compute Cluster

Scale Set (Dedicated compute)

Select the required scale set from the list.

Enable Compute Server Scaling
(Dedicated compute)

Select this checkbox to enable dedicated compute server scaling. The Min Node Count and Max Node Count fields are displayed.
Note: If you do not select this checkbox, only the max node count field is displayed.

• Min Node Count: Select the minimum node count that will be started initially.

• Max Node Count: Select the maximum node count up to which you want to scale.

Fetch Parameters

Clicking this will open a new dialog box where you need to provide the following details:

• fs.azure.account.auth.type: The OAuth input is displayed by default.

• fs.azure.account.oauth.provider.type: The input for this field is displayed by default.

• fs.azure.account.oauth2clientID: Enter the managed identity client ID.

• fs.azure.account.oauth2clientID: Enter the tenant ID.

Function

Function Deployment

Optionally, provide the name of the deployment where your Azure Functions are deployed.

Function

Function Configurations

Select the required function from the list:

• Using Function App: Enter the function app name.

• 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 analytical 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 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 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 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 the 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.
Note: Before enabling TLS, if you are using your own script for resource creation instead of the Kyvos shared scripts, you must rename the OpenSSL configuration file on the Kyvos Manager and the node where the Postgres Service is running. The OpenSSL configuration file is located at /etc/pki/tls/openssl.cnf.

To accomplish this, you will need to have sudo access.

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.

TLS Configuration

TLS Protocol

Select the version of SSL/TLS protocol to be used. For multiple versions, select the corresponding checkboxes.

TLS Certificate Mode

Select the mode from Use Path or Upload File.

Keystore

Provide the location of the keystore file. This file is used by the server when secure communication is enabled and required by the client when mutual authentication is enabled.
Example: /data/KM_SNI/Certificate/keystore.jks

Keystore Private Key

Enter the keystore password.

Truststore 

Provide the location (path) to read the trust store file. The client requires this file when secure communication is enabled and required by the server when mutual authentication is enabled.
Example: /data/KM_SNI/Certificate/truststore.jks

Truststore Private Key

Enter the truststore password.

Cipher Suite

Enter the encryption algorithm to be used for communication over the TLS layer.

Enable Mutual Authentication

Select to enable mutual authentication. 
Note: This option is displayed only if you have installed the Kyvos cluster using the war bundle. For other modes, Mutual authentication is enabled automatically.

Kyvos Web Portal Configuration

Use same certificate as TLS

Select this option to use the same TLS certificate for Kyvos Web Portal.

Use different certificate

• 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 HTTPS over TLS connector: If needed, provide attributes to be used for the TLS connector.

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