Versions Compared

Version Old Version 2 New Version Current
Changes made by

Sarabjeet Kaur

Sarabjeet Kaur

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. SSH to the node, where you want to install the Kyvos Manager.
    Go to /data/kyvos/installs/ location.

  2. Download the Kyvos bundle file provided by the Support team using the following command.
    wget <http://<BundleURL>
    Where the BundleURL is the URL provided by the Kyvos Support team for downloading the Kyvos Bundle file.

  3. Untar the bundle file using the following command.

    tar -xvf <bundle name>.tar.gz
    Where bundle name is the name of your tar file, such as KyvosManager2020.4_ux64.

  4. Set the following parameters in the setenv.sh file present in the  /kyvosmanager_war/kyvosmanager/bin folder.
    KM_BASE_PATH=<install location>/kyvosmanager_war/

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

Here, replace the <install location> with the path for Kyvos setup i.e. /data/kyvos/installs/<Kyvos version>

  1. Go to /data/kyvos/installs/kyvosmanager_war/kyvosmanager/bin folder, and start the Kyvos Manager using the following command.
    ./start-km.sh

...

Parameter

Description

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 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 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 Fetch 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.

Repository

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

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 or Kubernetes from the list.

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

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.

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 Deployment

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

...