Skip to content

You are viewing documentation for Immuta version 2023.1.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

cancel

Configure Snowflake Governance Features Integration

This page details how to install the Snowflake integration for users on Snowflake Enterprise. If you currently use Snowflake Standard, see the installation guide for that integration.

Policies Removed When Using CREATE OR REPLACE in Snowflake

If your workflow periodically replaces tables with the same table using the CREATE OR REPLACE statement in Snowflake, policies will be removed from those data sources in this integration.

To remedy this, you can enable native schema monitoring and follow this dbt and transform workflow.

Snowflake resource names

Use uppercase for the names of the Snowflake resources you create below.

  1. Click Native Integrations in the left panel of the App Settings page.
  2. Click the +Add Native Integration button and select Snowflake from the dropdown menu.

  3. Complete the Host, Port, and Default Warehouse fields.

  4. Opt to check the Enable Project Workspace box. This will allow for managed Write access within Snowflake. Note: Project workspaces still use Snowflake views, so the default role of the account used to create the data sources in the project must be added to the Excepted Roles List.

  5. Opt to check the Enable Impersonation box and customize the Impersonation Role name as needed. This will allow users to natively impersonate another user. Note you cannot edit this choice after you configure the integration.
  6. Opt to check the Enable Native Query Audit box. This will allow Immuta to ingest audit records for native queries.

  7. Opt to check the Automatically ingest Snowflake object tags box. This will enable Immuta to automatically import table and column tags from Snowflake. Note this feature requires an Enterprise Edition of Snowflake.

    Altering parameters in Snowflake at the account level may cause unexpected behavior of the Snowflake integration in Immuta

    The QUOTED_IDENTIFIERS_IGNORE_CASE parameter must be set to false (the default setting in Snowflake) at the account level. Changing this value to true causes unexpected behavior of the Snowflake integration.

  8. You have two options for installing the Snowflake and Snowflake Workspace access patterns: automatic or manual setup.

    Automatic Setup

    Immuta requires temporary, one-time use of credentials with specific permissions.

    When performing an automated installation, Immuta requires temporary, one-time use of credentials with the following permissions:

    • CREATE DATABASE ON ACCOUNT WITH GRANT OPTION
    • CREATE ROLE ON ACCOUNT WITH GRANT OPTION
    • CREATE USER ON ACCOUNT WITH GRANT OPTION
    • MANAGE GRANTS ON ACCOUNT WITH GRANT OPTION
    • APPLY MASKING POLICY ON ACCOUNT WITH GRANT OPTION
    • APPLY ROW ACCESS POLICY ON ACCOUNT WITH GRANT OPTION

    These permissions will be used to create and configure a new IMMUTA database within the specified Snowflake instance. The credentials are not stored or saved by Immuta, and Immuta doesn’t retain access to them after initial setup is complete.

    You can create a new account for Immuta to use that has these permissions, or you can grant temporary use of a pre-existing account. By default, the pre-existing account with appropriate permissions is ACCOUNTADMIN. If you create a new account, it can be deleted after initial setup is complete.

    Alternatively, you can create the IMMUTA database within the specified Snowflake instance manually using the Manual Setup option.

    1. From the Select Authentication Method Dropdown, select either Username and Password or Key Pair Authentication:

      Username and Password

      Complete the following fields: Username, Password, and Role.

      Key Pair Authentication

      1. Complete the Username field.
      2. Click Key Pair (Required), and upload a Snowflake key pair file.
      3. Complete the Role field.

    Manual Setup

    Best Practices: Account Creation

    The account you create for Immuta should only be used for the integration and should NOT be used as the credentials when creating data sources within Immuta. This will cause issues.

    Create a dedicated READ-ONLY account for creating and registering data sources within Immuta. This account should also not be the account used to configure the integration.

    The specified role used to run the bootstrap needs to have the following privileges:

    • CREATE DATABASE ON ACCOUNT WITH GRANT OPTION
    • CREATE ROLE ON ACCOUNT WITH GRANT OPTION
    • CREATE USER ON ACCOUNT WITH GRANT OPTION
    • MANAGE GRANTS ON ACCOUNT WITH GRANT OPTION
    • APPLY MASKING POLICY ON ACCOUNT WITH GRANT OPTION
    • APPLY ROW ACCESS POLICY ON ACCOUNT WITH GRANT OPTION

    It will create a user called "IMMUTA_SYSTEM_ACCOUNT", and grant the following privileges to that user:

    • APPLY MASKING POLICY ON ACCOUNT
    • APPLY ROW ACCESS POLICY ON ACCOUNT
    • Additional grants associated with the IMMUTA database
    • If you have selected to automatically ingest Snowflake object tags, which enables Snowflake Tag Ingestion,
      • GRANT IMPORTED PRIVILEGES ON DATABASE snowflake
      • GRANT APPLY TAG ON ACCOUNT

    1. Select Manual.

    2. Use the Dropdown Menu to select your Authentication Method:

      1. Username and Password: Enter the Username and Password and set them in the bootstrap script for the Immuta System Account Credentials.

      2. Key Pair Authentication: Upload the Key Pair file.

      3. Snowflake External OAuth:

        1. Create a security integration for your Snowflake External OAuth. Note that if you have an existing security integration, then the Immuta system role must be added to the existing EXTERNAL_OAUTH_ALLOWED_ROLES_LIST. The Immuta system role will be the Immuta database provided above with _SYSTEM. If you used the default database name it will be IMMUTA_SYSTEM.
        2. Fill out the Token Endpoint: Where the generated token is sent, also known as ‘aud’ (Audience) and ‘iss’ (Issuer).
        3. Fill out the Client ID: The subject of the generated token, also known as ‘sub’ (Subject).
        4. Optionally fill out Resource, depending on who the Authorization Server is.
        5. Fill out the x509 Thumbprint Certificate. This identifies the corresponding key to the token, often abbreviated as ‘x5t’ or also known as ‘sub’ (Subject).
        6. Upload the PEM Certificate: This is the client certificate that is used to sign the authorization request.

    3. Download, fill out the appropriate fields, and run the bootstrap script linked in the Setup section.

      Warning: Different Accounts

      The account used to enable the integration must be different from the account used to create data sources in Immuta. Otherwise, workspace views won't be generated properly.

  9. If you enabled a Snowflake workspace, select Warehouses from the dropdown menu that will be available to project owners when creating native Snowflake workspaces. Select from a list of all the warehouses available to the privileged account entered above. Note that any warehouse accessible by the PUBLIC role does not need to be explicitly added.

  10. Enter the Excepted Roles/User List. Each role or username (both case-sensitive) in this list should be separated by a comma.

    Excepted Roles/Users will have no policies applied to queries.

    Any user with the username or acting under the role in this list will have no policies applied to them when querying Immuta protected Snowflake tables in Snowflake. Therefore, this list should be used for service or system accounts and the default role of the account used to create the data sources in the Immuta projects (if you have Snowflake workspace enabled).

  11. Click Test Snowflake Connection.

  12. Once the credentials are successfully tested, click Save and Confirm your changes.