Projects Workflows

The HERE platform allows you to create and manage projects. As an admin of a project, you can grant other users, apps, and groups access to the project. Users with project access rights can create and manage project resources – catalogs, schemas, and pipelines. The compute, storage, and transfer usage associated with any project resource is automatically tracked based on project ID.

The OLP CLI provides tools for:

The following steps show how to create a project, add a catalog and a pipeline to the project, grant application access to the project's resources, list the resources associated with the project, remove the project's resources, and remove the project itself:

  1. Prepare:
  2. Create and list the project's catalog:
  3. Create and list the project's pipeline:
  4. Add an application to the project and list the project's application:
  5. Clean up project resources:

For more details, see Project Commands, Catalog Commands, and Pipeline Commands.

Create a Project

First, to manage any project resource, you need to create a project. For this, use the project create command:

olp project create <project-id> <project-name>

Note

Use unique values for the <project-id> and <project-name> placeholders. <project-id> must contain from 4 to 16 lowercase alphanumeric characters including hyphens. <project-id> cannot start or end with a hyphen.

The command creates the project and displays the project HRN. Note this HRN down as you'll need it later in the workflow.


Project hrn:here:authorization::myrealm:project/<project-id> has been created.

Create a Catalog and Add It to the Project

Follow the steps below to create a new catalog and add it to the project. Note that <catalog-id> must be unique.

Use the catalog create command and specify the catalog ID, name, summary, and project scope:

Linux
Windows
olp catalog create <catalog-id> scoped-catalog-name \
    --summary "A new scoped catalog" \
    --scope hrn:here:authorization::myrealm:project/<project-id>
olp catalog create <catalog-id> scoped-catalog-name ^
    --summary "A new scoped catalog" ^
    --scope hrn:here:authorization::myrealm:project/<project-id>

The command creates the catalog with the specified project scope and displays the catalog HRN. Note this HRN down as you'll need it later in the workflow.

The command displays the following results:


Catalog hrn:here:data:::<catalog-id> has been created.

List the Project's Catalog

To verify that the catalog has been created in the scope of the project, use the catalog list command:


olp catalog list --scope hrn:here:authorization::myrealm:project/<project-id>

The command displays the following results:


hrn:here:data:::<catalog-id>

Use olp catalog show <catalog HRN> to display more information about a catalog.

Create a Pipeline and Add It to the Project

Follow the steps below to create a new pipeline and add it to the project. Note that <pipeline-name> must be unique.

Use the pipeline create command and specify the pipeline ID, name, description, and project scope:

Linux
Windows
olp pipeline create <pipeline-name> \
   --description "This pipeline analyzes data" \
   --scope hrn:here:authorization::myrealm:project/<project-id>
olp pipeline create <pipeline-name> ^
   --description "This pipeline analyzes data" ^
   --scope hrn:here:authorization::myrealm:project/<project-id>

The command creates the pipeline with the specified project scope and displays the unique <pipeline UUID>. Note this UUID down as you'll need it later in the workflow to delete the pipeline.

The command displays the following results:


Pipeline has been created.
ID: <pipeline UUID>

List the Project's Pipeline

To verify that the pipeline has been created in the scope of the project, use the pipeline list command:


olp pipeline list --scope hrn:here:authorization::myrealm:project/<project-id>

The command displays the following results:


Available pipelines:

name                                    id                                      description
<pipeline-name>                         <pipeline UUID>                         This pipeline analyzes data

Note that the --scope <project HRN> parameter is also applicable to all pipeline template and pipeline version commands. For more details, see Pipeline Template Commands and Pipeline Version Commands.

For more information about pipeline workflows, see Pipeline Workflows.

Add an App to the Project

Follow the steps below to share the project with an app.

Use the project access grant command and specify the <App ID>, name, description, and project scope:

Linux
Windows
olp project access grant hrn:here:authorization::myrealm:project/<project-id> \
   --app <App ID>
olp project access grant hrn:here:authorization::myrealm:project/<project-id> ^
   --app <App ID>

Note

Use the olp credentials list command to get an <App ID>. For more information on how to create a new app and retrieve its app ID, see Credentials Setup and Credentials Commands.

The command displays the following results:


App <App ID> has been granted access to the project hrn:here:authorization::myrealm:project/<project-id>

Note that the OLP CLI not only supports granting project access to apps, users, and groups, but also adding apps or users as project administrators. For more details, see Project Access Commands and Project Admin Commands.

List the Project's App

To verify that the app has been added to the project, use the project access list command:


olp project access list hrn:here:authorization::myrealm:project/<project-id>

The command displays the following results:


Available members with project access:

type           HRN                                                                       id                       name
app            hrn:here:account::myrealm-test:app/<App ID>                               <App ID>                 My App

Delete the Project's Catalog

To delete the project-scoped catalog, use the catalog delete command:

Linux
Windows
olp catalog delete hrn:here:data:::<catalog-id> \
    --scope hrn:here:authorization::myrealm:project/<project-id>
olp catalog delete hrn:here:data:::<catalog-id> ^
    --scope hrn:here:authorization::myrealm:project/<project-id>

The command displays the following results:


Catalog hrn:here:data:::<catalog-id> has been removed.

Delete the Project's Pipeline

To delete the project-scoped pipeline, use the pipeline delete command:

Linux
Windows
olp pipeline delete <pipeline UUID> \
    --scope hrn:here:authorization::myrealm:project/<project-id>
olp pipeline delete <pipeline UUID> ^
    --scope hrn:here:authorization::myrealm:project/<project-id>

The command displays the following results:


Pipeline <pipeline UUID> has been deleted.

Remove the Application from the Project

To revoke the app's access to the project, use the project access revoke command:

Linux
Windows
olp project access revoke hrn:here:authorization::myrealm:project/<project-id> \
   --app <App ID>
olp project access revoke hrn:here:authorization::myrealm:project/<project-id> ^
   --app <App ID>

The command displays the following results:


App <App ID> has been revoked access to the project hrn:here:authorization::myrealm:project/<project-id>

Delete the Project

To delete the project, use the project delete command:


olp project delete hrn:here:authorization::myrealm:project/<project-id>

The command displays the following results:


Project hrn:here:authorization::myrealm:project/<project-id> has been deleted.

results matching ""

    No results matching ""