Installing the Snowflake Native App
In just four easy steps, you can install Kumo as a native Snowflake app to generate high-quality predictions, while keeping your data safely inside your Snowflake environment.
-
Get access to Kumo from the Snowflake Marketplace
-
Install Kumo
-
Create databases, roles, network rules, and privileges for Kumo
-
Launch and start using Kumo!
1. Get access to the Kumo Native app
Customers can access the Kumo Native app using
(a) the 30-day Free trial listing
(b)Request access for a full version to enterprise use. Click the Get
button, and then click Request
.
Note that the user needs to use the role ACCOUNTADMIN
or a role with IMPORT SHARE
and CREATE DATABASE
privileges to request the app.
2. Install Kumo
Prerequisites
Before installing and configuring Kumo as a native Snowflake application, ensure that you have completed the following:
-
Accept the Consumer terms of service for Snowflake marketplace. This needs to be done by a user with an ORGADMIN role.
-
Accept terms of service to enable third party python packages. This needs to be done by a user with an ORGADMIN role.
-
An account-level event table is configured. This can be verified by running
SHOW PARAMETERS LIKE 'event_table' IN ACCOUNT
. If an event table is not configured, follow the steps to create an event table and associate it with your account.
Currently supported settings for Kumo’s Native App to be used in Snowflake.
-
Private link is not enabled
-
If SSO is configured, it must be using SAML2 and not legacy SAML (see Migrating to SAML2)
-
Snowflake Account is on AWS.
Install the Kumo Native App
Note that the following steps can only be done using the ACCOUNTADMIN role or by an user/role with the appropriate privileges
-
You should see Kumo shared with you when navigating to “Data Products” → “Apps” in SnowSight. Click the
Get
button. -
Choose a warehouse to download the app and click
Get
in the next prompt. This warehouse is used to only install the app. -
The app will start installing and take 2-5 mins to complete.
-
Once the installation is completed, click on Done and setup Kumo using the instructions in the next section.
3. Setting up the Kumo Native app (run by an administrator)
Step 1: Create required objects and roles
The following SQL script creates the databases, roles, network rules and privileges required to setup Kumo in your account. It uses the ACCOUNTADMIN
role and a user with that role should execute it.
-
You are required to provide the warehouse name. Note that
ACCOUNTADMIN
must haveUSAGE
privilege on the warehouse provided. -
Set the name of the Kumo Native app if a different name was used when the app was installed from the marketplace. The app name defaults to
KUMO
.
Step 2: Grant privilege to use Kumo
The Snowflake administrator can provide access to the Kumo app to other users with the following commands. Modify <DEFAULT_USER_ROLE>
to the role used by the user to start and use Kumo.
4. Launch and Use Kumo
Note: This step is intended to be done by the user of Kumo.
Step 1: Start Kumo
- Provide warehouse to use and launch the Kumo app using the following commands. Note that the
KUMO_USER_ROLE
should have privileges to use the warehouse provided.
The above command returns the URL to use to access Kumo and can take 20-30 minutes to complete. DO NOT abort this command as this might leave the app in an inconsistent state.
- Navigate to the URL from the above command in your preferred browser. Login using your Snowflake credentials and you will see the Kumo UI.
Step 2: Using Kumo
For guidelines on how to use Kumo, visit the Kumo Quick Start Guide.
Step 3 (Optional): Shutting down Kumo
- At any point, you can stop the Kumo application using the following command. You can always start it back up using the commands in Step 1 - Kumo will retain all state from the previous usage.
Appendix
Deleting the Kumo Native app
You can reset your account and remove all objects associated with Kumo using the following script. Note that this will permanently delete all metadata, data and models trained with the Kumo Native app and this cannot be reverted. Please reach out to Kumo support if you have any questions regarding the deletion of your Kumo app.
Enabling mandatory event sharing for Kumo
Be sure to share ALL
events from the native app so that Kumo can provide any necessary operational support—this is required when using Kumo’s Snowflake native app. You can examine the logs and events shared with Kumo using the event table configured for your account. See Snowflake’s documentation for more details about event sharing.
Instructions to configure event sharing is below. Note that in both cases an event table must be configured for your Snowflake account. See Setting up an event table for details.
Configuring an existing Kumo Native App
Using Snowsight: If you have an existing Kumo app installation, you can easily enable mandatory events in Snowsight by going to Data Products
-> Apps
-> Kumo
-> Events and Logs
. On the Events and Logs
tab, toggle the All events
button in the Events and logs sharing
section.
Using SQL: The above event sharing can also be enabled using the following commands:
Configuring a New Kumo installation
All mandatory events will be enabled by default when installing Kumo. You will be notified of this when attempting to install the Kumo app. Note that an event table must be configured for your account to ensure installation can proceed.