Skip to content

Create a Project

Requirement: CREATE_PROJECT Immuta permission

Create a new project

Best practice: project naming convention

Use a naming convention for projects that reflects the naming convention for databases. (e.g., If the project in Dev is called: “my_project” name the project “dev_my_project.") The data will end up in the project database prefix, so you can trace the source and make edits upstream in that project as necessary.

  1. Navigate to the Projects tab under Data in the sidebar, and click the New Projects button.
  2. Fill out the Basic Information:

    1. Enter a name for your project in the Project Name field.
    2. Opt to complete the Project Description field to help identify your project.
    3. Opt to enter project Documentation to provide context for members.
  3. Select the purposes and any policy adjustments:

    1. Choose to select a purpose from the list of purposes or create a new purpose for the project.
    2. To create a new purpose, click Create Purpose and complete the prompts in the modal.

    Note that all purposes added to a project will need to be created or approved by a user with the GOVERNANCE or PROJECT_MANAGEMENT permission. Once purposes have been applied to a project, only these users can add data sources to the project.

  4. Add a native workspace configuration: Select your workspace configuration from the Workspace Configuration dropdown menu: Databricks or Snowflake.

    • Databricks: Opt to edit the sub-directory in the Workspace Directory field (this sub-directory auto-populates as the project name) and enter the Workspace Database Name.

    • Snowflake: Name the Workspace Schema. By default, the schema name is based off of the project name, but you can change it here. Your project workspace will exist within this schema under Snowflake under the database configured by the application admin.

      1. Use the dropdown menu to select the Hostname. Projects can only be configured to use one Snowflake host.

      2. Select one or more Warehouses to be available to project members when they are working in the native workspace.

  5. Add data sources to the project using the dropdown menu. Data sources can also be added after the project is created.

  6. Click Affirm and Create.

Set the project subscription policy

Projects are private by default but can be made public and shared with other users by changing the subscription policies setting. Governors are the only users who can manage subscription policies for projects with purposes.

  1. In the project, click the Policies tab.

  2. Click Edit Subscription Policy.

  3. Select the group of users who will have access:

    • Allow anyone: Selecting this option makes the project visible to everyone. Opt to require manual subscription by selecting the checkbox. This will require the users to manually subscribe to the project to gain access.

    • Allow anyone who asks (and is approved): Selecting this option makes the project visible in search results, but users must request access and be granted permission. This restriction supports multiple approving parties, so project owners can allow more than one approver or users with specified permission types to approve other users who request access to the project.

      1. Click Anyone or An individual selected by user from the first dropdown menu.

        Note: If you choose An individual selected by user, when users request access to a project they will be prompted to identify an approver with the permission specified in the policy.

      2. Select the USER_ADMIN, GOVERNANCE, or AUDIT permission from the subsequent dropdown menu. You can add more than one approving party by selecting + Add Another Approver.

    • Allow users with specific groups/attributes: Selecting this option allows users with the specified groups and attributes to join the project.

      1. Choose whether to build the policy off user groups or user attributes:
        1. is a member of group: Type the group name and select the group.
        2. possesses attribute: Type the attribute and select it. Then select the value from the dropdown menu.
      2. Opt to + Add Another Condition. When adding another condition, choose how the conditions will be required. If you select or, only one of the conditions must apply to a user for them to subscribe to the project. If you select and, all of the conditions must apply.
      3. Opt to allow users who do not meet the restrictions defined in the policy to still be able to discover the project by selecting the Allow Project Discovery checkbox.
      4. Once saved, users with the proper authorizations will be automatically subscribed. Opt to require users to manually subscribe to the project by selecting the Require Manual Subscription checkbox.
    • Allow individually selected users: Selecting this option hides the project from the search results. Project owners must manually add and remove users, and the Private label will appear next to the project name.

  4. Click Save to finish your policy.

Add users or groups to the project

  1. In the project, click the Members tab.
  2. Click the Add Members button.
  3. Start typing a user's or group's name in the Add Members modal and select it from the dropdown that appears.
  4. Opt to add an expiration to the subscription by entering the number of days until the access will expire.
  5. Select the role.
  6. Click Add.

Current project members will receive notifications that new users have been added to the project. A similar entry will be posted to the project's activity pane.