Step 1: Set up the IBM Cloud account

When you set up and administer Data Product Hub, you complete steps on both IBM Cloud and on Data Product Hub. Several important initialization steps are performed upon the initial login to Data Product Hub. The initial login can be performed by either the account administrator or by a delegated user.

Step 1: Set up the IBM Cloud account

Before you can configure Data Product Hub, the IBM Cloud account owner or administrator must complete the prerequisite configuration steps on IBM Cloud. On IBM Cloud, the account administrator creates an account, adds users or access groups, assigns roles, and provisions the Data Product Hub and IBM Cloud Object Storage services.

Required roles: IAM Platform role: IBM Cloud account owner or administrator

The following image outlines the steps that are performed by the IBM Cloud account administrator:

IBM Cloud account administrator tasks for setting up Data Product Hub

IBM Cloud configuration tasks
Task	Where performed?	Frequency
Create an account.	IBM Cloud	Once, unless more than one account is needed.
Provision the Data Product Hub service.	IBM Cloud catalog	Once. Only one instance of Data Product Hub is allowed per account.
Add users to the account.	IBM Cloud IAM	Initial setup and ongoing to add users.
Assign IAM roles, including the Data Product Hub Manager role.	IBM Cloud IAM	Initial setup and ongoing if roles change or new users are added.
Provision Cloud Object Storage.	IBM Cloud catalog	Once.

The Data Product Hub Manager role is an IAM service role that must be assigned to a user. That user must log in to initialize Data Product Hub.

Important:

Data Product Hub automatically generates a Service ID in your IBM Cloud account. The Service ID takes the form data-product-admin-service-id-catalog_id. The Service ID is required to process data product subscriptions in your catalog on IBM Cloud. Do not delete, lock, or modify the Data Product Hub Service ID. You can view the Service IDs for your account at Service IDs.

The Service ID requires an API key for authorization. A best practice for secure operations is to periodically rotate the Service API key. See Managing the Service API key.

Step 2: Initialize Data Product Hub

The initialization process automatically configures Data Product Hub to prepare it for your data community. A catalog is created with associated sample data products, delivery methods, workflows, and domains. The Data Product Hub Service ID is configured to make API calls.

Data Product Hub is initialized upon the initial login. The initial login must be performed by one of the following types of users:

The administrator for the IBM Cloud account, or
A delegated user with the Manager role for the Data Product Hub service.

You have a choice of 2 options for initializing Data Product Hub. For option 1, the account administrator performs the initial login step. For option 2, the account administrator delegates another user as the Data Product Hub Manager who performs the initial login step.

For instructions on how to log in to Data Product Hub, see Logging in to Data Product Hub.

Option 1: Account administrator logs in to initialize Data Product Hub

For option 1, the administrator for the IBM Cloud account logs in to Data Product Hub to initialize it. They then assign the IAM Manager role for the Data Product Hub service to themselves or another user. They are automatically added as a member of the Data Product Hub community with the Admin collaborator role.

Required roles for the account administrators: IAM Platform role for Data Product Hub: Any role; IAM Service role for Data Product Hub: Manager; Data Product Hub collaborator role: Admin (automatically assigned upon login)

The following image outlines the login step that is performed by the account administrator:

Initializing Data Product Hub

Initializing Data Product Hub
Task	Where performed?	Frequency
Log in to initialize Data Product Hub.	Data Product Hub login screen	Once.

Option 2: Data Product Hub Manager logs in to initialize Data Product Hub

For option 2, the account administrator delegates another user to perform the initial login step by assigning them the IAM Service role Data Product Hub Manager and other required roles. The Manager logs in to initialize Data Product Hub. When the Manager logs in to Data Product Hub for the first time, they are automatically assigned the Admin collaborator role. They can add more administrators to manage the Data Product Hub community by assigning users with the Admin collaborator role.

Required roles for the Data Product Hub Manager: IAM Platform role for All Account Management services: Administrator; IAM Platform role for Data Product Hub: Administrator; IAM Service role for Data Product Hub: Manager; Data Product Hub collaborator role: Admin (automatically assigned upon login)

The following image outlines the login step that is performed by the Data Product Hub Manager:

Initializing Data Product Hub

Initializing Data Product Hub
Task	Where performed?	Frequency
Log in to initialize Data Product Hub.	Data Product Hub login screen located at https://dataplatform.cloud.ibm.com/dpx?context=dph	Once
Add an administrator to the Data Product Hub community with the Admin collaborator role.	Manage community page located at Administration>Configurations and settings>Manage community	Once

Step 3: Set up Data Product Hub

After Data Product Hub is initialized by logging in, the Data Product Hub Admin adds members to the data community and assigns collaborator roles. The Admin role is automatically assigned to the user that initializes the instance, but can also be assigned to any other users. The Admin sets up storage for data contracts and data extracts, and manages data source connections.

Required roles: IAM Platform role: Any role; Data Product Hub collaborator role: Admin

The following image outlines the steps to set up the Data Product Hub community:

Data Product Hub configuration

Data Product Hub Admin tasks
Task	Where performed?	Frequency
Create a bucket in a Cloud Object Storage instance to store data contracts.	Data Product Hub Configurations and settings	Once, unless a new Cloud Object Storage instance is needed.
Add users and assign roles to manage the data community.	Data Product Hub Configurations and settings	Initial setup and ongoing if roles change or new users are added.
Manage data source connections.	Data Product Hub Configurations and settings	Ongoing.

Learn more

Parent topic: Documentation for Data Product Hub