search

SGCI / sgci-resource-inventory

This contains all the computational resource entities
https://sgci-resource-inventory.readthedocs.io/en/latest/introduction.html
Apache License 2.0
6 stars 2 forks source link

Unique identifiers for resources #9

Closed joestubbs closed 2 years ago

joestubbs commented 3 years ago

Based on discussions with the group and JP Navarro at XSEDE, we propose using the following scheme for unique identifiers for SGCI resources: each organization that will contribute resource definitions under their control will be assigned a "virtual organization id". Examples of such organizations could include: Airavata, IU, HubZero, SDSC, Tapis, TACC, XSEDE, Open On Demand, etc. The virtual organization id for an organization should be a fully qualified domain name (FQDN) owned by the organization; for example, "xsede.org" for XSEDE, "tacc.utexas.edu" for TACC, etc. Within a virtual organization, it is up to that organization to generate an identifier for each resource that will make it unique. We refer to this as the "virtual organization resource id". This could be anything from an internal database id (e.g., 1, 2, 3, etc.), or a string whose uniqueness is enforced by a database constraint, to a UUID.

Given these definitions, the format for the complete SGCI resource identifier is proposed to be: resources.sciencegateways.org..

For example, for the Stampede2 resource within the TACC virtual organization, with virtual organization id "tacc.utexas.edu", the following id's are valid: resources.sciencegateways.org.tacc.utexas.edu.stampede2 resources.sciencegateways.org.tacc.utexas.edu.7 resources.sciencegateways.org.tacc.utexas.edu.04ea2969-f450-48db-a7ce-df69c761dbf4

Additionally, we propose to add new fields to the spec: virtualOrganizationId virtualOrganizationResourceId

For the above Stamped2 example, these fields would have the following values: virtualOrganizationId: tacc.utexas.edu (in all three cases) virtualOrganizationResourceId: stampede2, 7, and 04ea2969-f450-48db-a7ce-df69c761dbf4, respectively.

joestubbs commented 3 years ago

I've created https://github.com/SGCI/sgci-resource-inventory/pull/10 with updates to the resource definitions and docs to support this proposal.

joestubbs commented 2 years ago

we decided to not use the VO idea but to require the "name" attribute to be unique.