Oracle Cloud Infrastructure Documentation

Get Started with Data Catalog

Get started with Oracle Cloud Infrastructure Data Catalog by creating the user groups and access policies needed to create a data catalog.

This tutorial is directed at administrator users because they are granted the required access permissions.

In this tutorial, you:

  1. Create a user group for data catalog admins. Optionally create user group(s) for other users, such as data catalog data engineers, data scientists, data stewards, and data officers.
  2. (Optional) Create a compartment for your data catalog objects.
  3. Create policies to give your data catalog admins and other user groups access to use data catalog resources.
  4. Create a data catalog.

For additional information, see Data Catalog Overview.

Before You Begin

To successfully perform this tutorial, you must have the following:

  • An Oracle Cloud Infrastructure account. See signing up for Oracle Cloud Infrastructure.
  • At least one user in your tenancy who wants to work with Data Catalog. This user must be created in the Identity service.

1. Create an Admin User Group

A new user has no permissions until you place the user in one or more groups and create at least one policy to give that group permission to either the tenancy or compartment.

To create a user group and add users to this group, perform the following steps:

  1. Open a supported browser and enter the Console URL. 
    https://console.<tenancy-region>.oraclecloud.com
    The <tenancy-region> can be us-ashburn-1, us-phoenix-1, and so on. Use one of the Data Catalog supported regions.
  2. Enter your cloud tenancy and click Continue.
  3. Sign in with your credentials.
  4. Open the navigation menu and click Identity & Security. Under Identity, click Groups.
  5. Enter a name for your user group. For example, data-catalog-admins.
  6. Enter a description. For example, Group of data catalog admin users.
  7. Click Create.
  8. The new group is created. Click the group name.
  9. Add the users you want in this group. These users must be created in Identity under Identity & Security.
  10. Click Add.
You have successfully created a group for data catalog admin users and added one or more users to this group.
(Optional) Create More User Groups

Data Catalog is used by various data professionals, such as data engineers, data scientists, data stewards, and chief data officers. Each type of user should be given the permissions they require to do their tasks. You can create different groups for each type of user to manage these permissions effectively. In this tutorial, you create one group for all data catalog users.

To create a user group, perform the following steps:

  1. Open the navigation menu and click Identity & Security. Under Identity, click Groups.
  2. Enter a name for your user group. For example, data-catalog-users.
  3. Enter a description. For example, Group of data catalog users.
  4. Click Create.
  5. The new group is created. Click the group name.
  6. Add the users you want in this group. These users must be created in Identity under Identity & Security.
  7. Click Add.
You have successfully created another user group for Data Catalog.

2. (Optional) Create a Compartment

Compartments help you organize and isolate your resources to make it easier to manage and secure access to them.

To create a compartment in your tenancy, perform the following steps:

  1. Click Compartments.
  2. Click Create Compartment.
  3. Enter a name for your compartment. For example, data-catalog-work.
  4. Enter a description. For example, Compartment for data catalog work.
  5. Click Create Compartment.
You have successfully created a compartment for your data catalog resources.

3. Create Policies

A policy specifies who can access which Oracle Cloud Infrastructure resources that your company has, and how.

Create Policies for Administrators

Data Catalog administrators need access to perform all data catalog related operations including configuring private networks.

To create a policy for administrators, perform the following steps:

  1. Click Policies.
  2. Click Create Policy.
  3. Enter a name for the policy. For example, data-catalog-admin-policies.
  4. Enter a description. For example, Policies for data catalog admins.
  5. Enter the following statement to allow the admin users to perform all operations on all data catalog resources in a given compartment. 
    allow group data-catalog-admins to manage data-catalog-family in compartment data-catalog-work
    See policy examples to create the policy statement for your access requirements.
  6. Click + Add Statement.
  7. Enter the following statement to allow the admin users to perform all networking-related operations in a given compartment. 
    allow group data-catalog-admins to manage virtual-network-family in compartment data-catalog-work
  8. Click + Add Statement.
  9. Enter the following statement to allow the admin users to view Oracle Cloud Infrastructure users in the Console. 
    allow group data-catalog-admins to inspect users in compartment data-catalog-work
  10. Click Create.
You have successfully created the policy needed by data catalog admins.
Create Policies for Data Catalog Users

Data Catalog users need the appropriate access to perform their required operations in a data catalog.

To create a policy for data catalog users, perform the following steps:

  1. Click Policies.
  2. Click Create Policy.
  3. Enter a name for the policy. For example, data-catalog-users-policies.
  4. Enter a description. For example, Policies for data catalog users.
  5. Enter the following statement to allow the data catalog users to use all data catalog resources. 
    allow group data-catalog-users to use data-catalog-family in compartment data-catalog-work
    See policy examples to create the policy statement for your access requirements.
  6. Click + Add Statement.
  7. Enter the following statement to allow the data catalog users to view Oracle Cloud Infrastructure users in the Console. 
    allow group data-catalog-users to inspect users in compartment data-catalog-work
  8. Click Create.
You have successfully created the policy needed by data catalog users.

4. Create a Data Catalog

When you create a data catalog, you get a single collaborative environment to manage technical, business, and operational metadata. You can collect, organize, find, access, understand, enrich, and activate this metadata.

To create a data catalog, perform the following steps:

  1. Open the navigation menu and click Analytics and AI. Under Data Lake, click Data Catalog.
  2. Click Create Data Catalog.
  3. Select the compartment that you created previously for your data catalog work.
  4. Enter a name for the data catalog instance.
  5. (Optional) Enter one or more tags for your data catalog resource. Tags help organize and track all the resources within your tenancy.
  6. Click Create Data Catalog. The data catalog is created within seconds and is listed in the Data Catalogs page.
You have successfully created a data catalog.