resource project

The OLP CLI supports the following commands:

• list all the projects that are either the home project for a resource or projects to which the resource is linked.
• add the specified project as a home project for resources (catalogs and schemas) originally created outside of a project.
• remove the specified project as a home from the resource. This is only available for catalogs and schemas originally created outside of a project.

resource project list

List all projects that are either the home project or projects to which it is linked, or show that it does not belong to a project.

olp resource project list  [command parameters]

Required parameters:

• <resource HRN> Specifies the HRN of the resource.

Optional parameters:

• --relation <home|reference> The relation of resources to the project. home denotes a resource located within a project while reference denotes a resource linked to the project.
• --cross-realm Includes projects from different realms if there is a valid cross-realm trust established between the home project/realm and those other realms.
• --limit <max number of projects> Specifies the maximum number of projects returned in the result (100 by default).
• --credentials <path to credentials file> Specifies the name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
• --profile <profile name> Specifies the name of the credentials profile to use from the olpcli.ini file.
• --json Displays the command result in JSON format.
• --quiet Displays the project HRNs, each on a new line.

For more information on using credentials and profiles, see Credentials setup.

Example:

olp resource project list hrn:here-cn:data::org:my-catalog --json

Output:

{
  "projects": 
    [ 
      {
        "id": "my-project-0000",
        "hrn": "hrn:here:authorization::org:project/my-project-0000",
        "name": "My Project 0",
        "description": "This is my demo Project",
        "relation": "home"
      },
      {
        "id": "my-project-0001",
        "hrn": "hrn:here:authorization::org:project/my-project-0001",
        "name": "My Project 1",
        "description": "This is my demo Project",
        "relation": "reference",
        "allowedActions": [
          "readResource"
        ]
      }
    ]
}

resource project add

Add a specified project as a home project for a resource (catalog/schema). This is true for those resources that were originally created outside of projects. That way, you can take advantage of platform project management features, including tracking of usage/cost and access management at project level. Note that each resource can only have one home project. Also note that this command is not supported for pipelines, which can be moved into a home project using the olp pipeline move command.

olp resource project add   [command parameters]

Required parameters:

• <resource HRN> The HRN of the resource, where the resource is either a schema or a catalog. Schema HRN may or may not contain a version number which will not affect the command result
• <project HRN> The HRN of the project to add as resource home.

Optional parameters:

• --credentials <path to credentials file> Specifies the name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
• --profile <profile name> Specifies the name of the credentials profile to use from the olpcli.ini file.
• --json Displays the command result in JSON format.
• --quiet Displays empty output with no additional information.

For more information on using credentials and profiles, see Credentials setup.

Example:

olp resource project add hrn:here-cn:data::org:my-catalog hrn:here-cn:authorization::org:project/my-project-0000

Output:

Resource hrn:here-cn:data::org:my-catalog has been added to the project hrn:here-cn:authorization::org:project/my-project-0000

resource project remove

Remove the specified project as a home from the resource. You can use this command to undo the addition of a home project for a catalog created outside of projects with the above command.

olp resource project remove   [command parameters]

Required parameters:

• <resource HRN> The HRN of the resource, where the resource is either a schema or a catalog. Schema HRN may or may not contain a version number which will not affect the command result.
• <project HRN> The HRN of the project to remove as resource home.

Optional parameters:

• --credentials <path to credentials file> Specifies the name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
• --profile <profile name> Specifies the name of the credentials profile to use from the olpcli.ini file.
• --quiet Displays empty output with no additional information.

For more information on using credentials and profiles, see Credentials setup.

Example:

olp resource project remove hrn:here-cn:data::org:my-catalog hrn:here-cn:authorization::org:project/my-project-0000

Output:

Resource hrn:here-cn:data::org:my-catalog has been removed from the project hrn:here-cn:authorization::org:project/my-project-0000