Initial Setup

To get started with Honeydew, you need to complete the following steps:

1. Honeydew Application org and admin user provisioning
2. Snowflake Native Application installation
3. Snowflake access setup

Optional:

1. Git Integration
2. BI Integration

​

Honeydew Application

​

Org provisioning and admin user

Get your Honeydew org set up, and have an admin user provisioned. Contact Honeydew support to help with this step (support@honeydew.ai). Once provided, you will be able to access the Honeydew application. The admin user will be able to invite additional users to the org, and manage org settings.

​

Network Access

If your organization is using Zscaler or similar security solutions, Honeydew application access might be blocked by default within the organization’s network. In that case, please make sure that *.honeydew.cloud is added to the allowlist.

If specific domains are required (wildcards not allowed), please add the following domains to the allowlist:

1. api.honeydew.cloud
2. app.honeydew.cloud
3. auth.honeydew.cloud
4. jdbc.honeydew.cloud

​

Users Login

1. Honeydew supports user login using username/password as well as using Google accounts. For other login methods as well as for SSO, please reach out to Honeydew support (support@honeydew.ai).
2. MFA is enabled and enforced for all users by default, with the option to manage it through user settings. It requires a one-time password generated by Google Authenticator, Duo Security or similar tools.

​

API Keys

1. Honeydew allows the use of API Keys for API integration, supporting BI tools, Snowflake Native App, SQL interface and more.
2. Honeydew offers direct programmatic API access in private preview. To request access, contact support@honeydew.ai.
3. API Keys are created and managed at the organization level (similar to service accounts).
4. To generate an API Key, navigate to the Settings section in the Honeydew application (Administrator permissions are required).

​

Snowflake Native Application

Install the Honeydew Native Application for Snowflake. Follow the steps listed here.

​

Snowflake Access Setup

Honeydew is built on top of Snowflake and requires access to Snowflake in order to operate. You have two options to set up Snowflake access - either using a central org-level connection parameters or map your individual Snowflake user credentials to Honeydew.

If you would like to use a central org-level connection, it is advised to create a new dedicated Snowflake user for Honeydew integration. The following Snowflake connection parameters are required for Honeydew setup:

1. Account name
2. Username
3. Role
4. Warehouse

Honeydew supports both key-pair and password-based authentication for Snowflake.

• For key-pair authentication, the following are required:

  1. Private Key
  2. Private Key Passphrase (if used)

• For password-based authentication, a password is required.

The following Snowflake connection parameters are required to be able to deploy dynamic datasets to Snowflake:

1. Database - the database where Honeydew will deploy any dynamic datasets as views or tables
2. Schema - the schema where Honeydew will deploy any dynamic datasets as views or tables
3. Dev Database - the database where Honeydew will deploy any dynamic datasets as views or tables when working on a dev branch
4. Dev Schema - the schema where Honeydew will deploy any dynamic datasets as views or tables when working on a dev branch

​

Allowing Honeydew IPs

If you have IP-based access restrictions in Snowflake, add the IP addresses displayed in the Snowflake connection screen to the “Allowed IP Addresses” list:

• 34.86.209.90
• 34.145.147.92

​

Permissions

Honeydew does not process any Snowflake data, but only reads metadata and deploys views/tables. You can find more security-related information here.

If using an integration user deployment, the Honeydew integration user/role require the following permissions to operate:

1. USAGE on any databases and schemas which will be used as part of the semantic layer
2. SELECT on any tables/views which will be used as part of the semantic layer
3. CREATE TABLE and CREATE VIEW on the database/schema where dynamic datasets will be deployed

-- Grant the SNOWFLAKE.CORTEX_USER role to the user role created for Honeydew integration
GRANT DATABASE ROLE SNOWFLAKE.CORTEX_USER TO ROLE HONEYDEW_USER_ROLE;

​

Git Integration

Honeydew uses Git as the underlying storage for any created semantics as well as for version control.

​

GitHub

You can either onboard using a Honeydew-managed GitHub private repository, or use your own GitHub repository. If you would like to use your own repository, please complete the following steps:

1. Create a new GitHub private repository using one of these options:
   • Create a new repository
   • Clone from the Honeydew quick-start example.
2. The full repository name - org-name/repository-name (e.g. honeydew-ai/honeydew-quickstart) will be required for Honeydew setup.
3. Install the Honeydew GitHub application, and provide it with access to the newly created repository.
4. The app installation id (the number at the end of the URL, like 11122333 for https://github.com/apps/honeydew-ai/installations/11122333) would be required for Honeydew setup. To get to the url that contains your installation id, go to https://github.com/organizations/<your-github-organization>/settings/installations, and then click on the Honeydew.ai application.

​

GitLab

Coming soon.

If you do not have a GitHub account, you can use a Honeydew-managed repository for Honeydew setup.

​

Azure DevOps

Coming soon.

If you do not have a GitHub account, you can use a Honeydew-managed repository for Honeydew setup.

​

BI Integration

You can find more details on how to integrate Honeydew with your BI tool here.

​

Uninstalling Honeydew

In order to uninstall Honeydew, please follow the next steps:

1. Remove the Honeydew Native Application from Snowflake.
2. Remove the Honeydew GitHub application from your GitHub account.
3. Optionally, remove the dedicated GitHub repository created for Honeydew.
4. Remove Snowflake integration user, role, warehouse if these were created for Honeydew integration.
5. Remove Honeydew IP addresses from the Snowflake “Allowed IP Addresses” list, if these were added.
6. Remove any created data sources from your BI tool. Also, remove any drivers that might have been installed for Honeydew integration.
7. Contact Honeydew support at support@honeydew.ai, to remove your Honeydew org and users.

​

Training & Support

We offer a free 1-hour training workshop during the trial period. It is recommended to schedule the workshop on the 2nd week of the trial period. You can book your training workshop using this link.

For any questions during the onboarding phase or the trial period, please reach out to support@honeydew.ai.