How to request roles for hook service on My DataLake Services

This guide shows how to request access and quota roles for the hook service on My DataLake Services — including how to modify and remove roles.

Hook service provides ready-to-use, high-level serverless workflows and functions preconfigured to efficiently access and manipulate DEDL data.

What we are going to cover

Prerequisites

No. 1 Account

You need to have a profile on My DataLake Services: How to create a profile on My DataLake Services.

No. 2 Administrative privileges within a project

You must be an admin member of a project that has been approved by the operator.

To create a project, follow this guide: How to create a project on My DataLake Services.

Or, join an existing project and have an admin grant you privileges.

Anyway, sign in to My DataLake Services: https://application.data.destination-earth.eu/

Enabling hook service

There are two ways to set up any service, one is while creating a project and the other afterwards, from the Role requests menu.

Start creating project as described in Prerequisite No. 2. Mark the hook checkbox:

../../_images/add-hook-when-defining-the-project.png

Finish creating the project, waiting for operator and all. In Active roles you will see two roles active:

  • hda, the one that is the default in all projects and

  • hook, the one that was created with the project itself.

In option Role requests, the hook service will already be marked with a button Edit access.

../../_images/hook-role-edit-access-activated.png

Choosing which role to request

The other way is creating a blank project, that is, with just the hda default role. Navigate to Role requests:

../../_images/hook-not-initialized.png

If you do not already have access to hook, click the Request access button.

You will arrive at a page with two sections: Access roles and Quota roles. Both are required.

Access roles

The hook service has a single access role:

hook-workflows

Access to Hook Service (processing)

Click the Select role button:

../../_images/hook-role--1.png

Fill in the Description of planned activities field to justify your request.

Click the Request role button to proceed to the quota role section.

Quota roles

hook-low

Low quota for Hook Service (processing). 25 product orders per month, maximum 1 parallel order item.

hook-medium

Medium quota for Hook Service (processing). 1000 product orders per month, maximum 2 parallel order items.

hook-high

High quota for Hook Service (processing). 1000 product orders per month, maximum 5 parallel order items.

../../_images/my-hook-roles-3.png

Select a quota role and complete the Description of planned activities field.

Click the Request role button to finalize.

Operator approval

Your request will be reviewed by the DEDL operator. Once approved, the role appears under Active roles.

Viewing role requests and status

To see your submitted or past role requests, navigate to AccessRole requests. You can click Details to view the operator’s response or take actions like deleting or editing a request.

../../_images/my-hook-roles-4.png

Each entry includes Details and Delete options.

../../_images/my-hook-roles-6.png

Click Details to see more information about any request:

../../_images/my-hook-roles-7.png

How to change roles for hook service

You cannot change access roles (there is only one), but quota roles can be changed.

Suppose you want to downgrade your quota. The current state is hook-high, as shown under Active roles:

../../_images/my-hook-roles-8.png

To change to hook-low, click Role requests, then click Edit access in the row for hook:

../../_images/hook-role--10.png

You will now be able to choose from the other available quota roles for the hook service:

../../_images/my-hook-roles-9.png

There are three available quota roles. Since you already have hook-high, you may now switch to hook-low or hook-medium.

Once submitted, the new quota role request will be marked PENDING:

../../_images/my-hook-roles-10.png

You can now:

  • Delete the request before review.

  • Wait for operator approval or rejection.

Click Details to read any rejection messages.

Deleting a pending request

You may delete a quota role request before it is reviewed.

Click the Delete button. You’ll be prompted to confirm or cancel:

../../_images/my-hook-roles-11.png

If confirmed, a message will appear in the lower-right corner of your browser window:

../../_images/stack-jupyter-role--6.png

The request will be marked REJECTED:

../../_images/my-hook-roles-12.png

If you do not delete the request, the operator will eventually review and either approve or reject it.

If approved, the request becomes APPROVED:

../../_images/my-hook-roles-13.png

To verify the change, click on Active roles and check that your quota now reflects hook-low:

../../_images/my-hook-roles-14.png

If rejected, click Details to read the operator’s message. It may say “Not available” or any other reason.

Role request statuses

Status

Meaning

PENDING

Awaiting review by operator

APPROVED

Request accepted and role is active

REJECTED

Request denied; see operator message in Details

Email notifications

Every role request update sends an email to the address used for your login. It looks like this:

../../_images/my-hook-roles-15.png

Example of a notification email for a role status change.

Using the search mechanism in your email client, you can track every change in quota status for any service in My DataLake Services.

How to remove access to a service

For each service, one quota role and at least one access role are required. If quota and/or access role is missing, service will not be available. To eliminate access role for the hook service, click on User & privileges to see access roles that are active:

../../_images/hook-active-access-role.png

Now click on checkbox near hook-workflows, which will make it inactive while the Save button is now active.

../../_images/checkbox-not-active-for-hook-workflows.png

Click on Save produces a message in lower right corner:

../../_images/access-role-updated-successfully3.png

and the now there is no active access role for hook service. To verify, click on Active roles and see that hook only has a quota role but not the access role, meaning, it cannot access the data.

../../_images/hook-without-access-role.png

How to delete the account

If you want to stop being an owner of a My DataLake Services account, you use Delete account button from the Profile page. See How to create a profile on My DataLake Services.

Next steps

You should now have access to all features associated with your new roles and can begin using the hook service with the assigned quotas.

See status page for Destination Earth Data Lake hook service.