Pod Provisioning Service#

Starting in ESS 2.0, Pod provisioning and storage is handled by a separate Pod Provisioning Service and Pod Storage Service.

Pod Provisioning/Creation#

ESS’ Pod provisioning service manages the creation of Pods, using the following URL format:

https://storage.{ESS Domain}/{Unique Root Container}/

Prior to version 2.0, ESS Pods used URLs of the form https://{ESS Domain}/{username}/.

Default Resource (Extended Profile)#

When creating a Pod, ESS creates an extended profile resource. The extended profile resource is separate from the public WebID profile. The extended profile resource, unlike the public WebID profile, is hosted in the user’s Pod, and by default, is private. Users can grant or deny access to their extended profile like any other resource in their Pod.

Initial ACP Policies#

When a Pod is created, like any other Pod resource, an Access Control Resource is also created for the Pod Root. The ACR is initialized with default ACP policies.

The initial policies give the Pod Owner read and write access to the Pod. These policies also specify a client matcher as well if the Authorization service’s configuration for the initial client allow list is set:

INRUPT_AUTHORIZATION_DEFAULT_ACR_CLIENT_ID_ALLOW_LIST or if that is unset,
INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST.

Disambiguation

Both Authorization Service and Pod Storage Service have a INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST setting.

Only the Authorization Service setting affects which clients are allowed. The Pod Storage Service is for Discovery purposes only.

A Pod’s Initial Policies are set when the Pod is provisioned. As such, updates to the operator-controlled allow lists do not affect existing Pods.

Note

Starting in 2.1, ESS uses the values in its Authorization service’s INRUPT_AUTHORIZATION_DEFAULT_ACR_CLIENT_ID_ALLOW_LIST (at the time of Pod creation) to create the client matcher for the initial ACP policies. If the setting is unset, ESS uses the values in its Authorization service’s INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST (at the time of Pod creation).

Using the value of the Pod owner’s WebID and an initial client allow list, ESS creates the initial policies of the form:

If allOf(AgentMatcher and ClientMatcher) evaluates to true, Then allow (Read and Write).

Specifically, ESS creates:

Policy 1 for the Pod Root:

If the agent matches the Pod owner’s WebID, and if the client application’s Client ID has a match in the initial client allow list, allow Read and Write access.

Policy 2 for the Pod Root’s Initial Member Policies:

If the agent matches the Pod owner’s WebID, and if the client application’s Client ID has a match in the initial client allow list, allow Read and Write access.

For more information on a Container’s Member Policies, see Member Policies.

Note

Starting in 2.1, ESS uses the values in Authorization service’s INRUPT_AUTHORIZATION_DEFAULT_ACR_CLIENT_ID_ALLOW_LIST (at the time of Pod creation) to create the client matcher for the initial policies. If the setting is unset, ESS uses the values in its Authorization service’s INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST (at the time of Pod creation).

If the initial client allow list is empty (when creating the policy), ESS uses the value of the Pod owner’s WebID to create initial policies of the form:

If allOf(AgentMatcher) evaluates to true, Then allow (Read and Write).

Specifically, ESS creates:

Policy 1 for the Pod Root:

If the agent matches the Pod owner’s WebID, allow Read and Write access.

Policy 2 for the Pod Root’s Initial Member Policies:

If the agent matches the Pod owner’s WebID, allow Read and Write access.

For more information on a Container’s Member Policies, see Member Policies.

Note

After a Pod’s initial policies have been created, changes to INRUPT_AUTHORIZATION_DEFAULT_ACR_CLIENT_ID_ALLOW_LIST (or INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST) do not impact the Pod’s policies.

Provisioning Endpoints#

Create a New Pod#

The ESS Pod provisioning service provides an endpoint that client applications can use to create new Pods.

Important

Access to this endpoint requires users to be authenticated.

The following configurations, if set, may affect the behavior of this endpoint:

INRUPT_JWT_ISSUER_ALLOW_LIST
INRUPT_JWT_ISSUER_DENY_LIST
INRUPT_STORAGE_MAX_PODS_PER_OWNER.

To create a new Pod (and the extended profile resource), a client will issue an authenticated POST request to the endpoint.

Method:	`POST`
Endpoint:	`https://provision.{ESS domain}/`
Body:	N/A
Content-Type:	N/A

Upon successful creation (status 201), the endpoint returns a Location header with the location of the new Pod. In addition, the response contains a JSON payload with information about the newly created Pod:

{
   "@context":{
      "id":"@id",
      "storage":{
         "@type":"@id",
         "@id":"http://www.w3.org/ns/pim/space#storage"
      },
      "profile":{
         "@type":"@id",
         "@id":"http://xmlns.com/foaf/0.1/isPrimaryTopicOf"
      }
   },
   "id":"{WebID}",
   "profile":"https://storage.{ESS Domain}/{Root Container}/profile",
   "storage":"https://storage.{ESS Domain}/{Root Container}/"
}

`@context`	Contains the following context for Pod information fields: { "id":"@id", "storage":{ "@type":"@id", "@id":"http://www.w3.org/ns/pim/space#storage" }, "profile":{ "@type":"@id", "@id":"http://xmlns.com/foaf/0.1/isPrimaryTopicOf" } }
`id`	The WebID of the authenticated user for whom the Pod has been created.
`profile`	The URL of an extended profile resource stored on the Pod. The URL has the form `https://storage.{ESS Domain}/{Root Container}/profile`. Note The extended profile resource is separate from the public WebID Profile Document. As with any resource in a user’s Pod, the extended profile resource is private by default.
`storage`	The URL root of the newly created Pod. The URL has the form `https://storage.{ESS Domain}/{Root Container}`.

This payload can be used to update the WebID Profile with the Pod information.

List Pods for a User#

The ESS Pod provisioning service provides an endpoint that client applications can use to list a user’s Pods.

Important

Access to this endpoint requires users to be authenticated.

To list Pods for the logged in user, a client can issue an authenticated GET request to the endpoint.

Method:	`GET`
Endpoint:	`https://provision.{ESS domain}/list`
Body:	N/A
Content-Type:	N/A

The endpoint returns an array of the unique Root Containers (relative to the Storage base URL), prefixed with a slash “/”; e.g.,

[
  "/973ef337-ce21-4762-975b-671ac6ebc180/",
  "/e3fefa9f-4fe0-4e4c-a5b6-81be0f12fe9c/"
]

Using the appropriate programming language URL builder/constructor, the client can construct the Pod URL using the Storage base URL value (for example, https://storage.{ESS domain}) and the returned Root Containers.

To determine the base URL value, see INRUPT_STORAGE_HTTP_BASE_URL.

Configuration#

As part of the installation process, Inrupt provides base Kustomize overlays and associated files that require deployment-specific configuration inputs.

The following configuration options are available for the service and may be set as part of updating the inputs for your deployment. The Inrupt-provided base Kustomize overlays may be using updated configuration values that differ from the default values.

Provision Options#

INRUPT_STORAGE_HTTP_BASE_URL#

The base URL of the storage service.

Important

The value requires a trailing slash /; e.g., https://storage.{ESS_DOMAIN}/.
Ensure that Pod Provision Service’s INRUPT_STORAGE_HTTP_BASE_URL value is consistent with the Pod Storage Service’s INRUPT_STORAGE_HTTP_BASE_URL value.

INRUPT_STORAGE_MAX_PODS_PER_OWNER#

Default: 10

For Pod Provision Service Only

The maximum number of Pods owned by a specific WebID.

Important

The INRUPT_STORAGE_MAX_PODS_PER_OWNER value must equal value must equal Authorization Service’s INRUPT_AUTHORIZATION_MAX_POD_COUNT value. When changing the INRUPT_STORAGE_MAX_PODS_PER_OWNER value, ensure you also update INRUPT_AUTHORIZATION_MAX_POD_COUNT to the same value.

Solid-OIDC Issuer Configuration Options#

INRUPT_JWT_ALLOWED_SIGNATURE_ALGORITHMS#

Default: ES256, RS256

A comma-separated list that specifies the allowed encryption algorithms used to sign ID tokens.

INRUPT_JWT_ISSUER_ALLOW_LIST#

A comma-separated list of trusted issuers of Solid-OIDC tokens.

If unset, the service accepts Solid-OIDC tokens from all issuers with the exception of those in the INRUPT_JWT_ISSUER_DENY_LIST.
If set, the service accepts only the Solid-OIDC tokens from the issuers in the list with the following exception:
- If an issuer is in both INRUPT_JWT_ISSUER_ALLOW_LIST and INRUPT_JWT_ISSUER_DENY_LIST, the INRUPT_JWT_ISSUER_DENY_LIST supersedes the INRUPT_JWT_ISSUER_ALLOW_LIST and the issuer is not accepted by ESS.

Logging Configuration#

QUARKUS_LOG_LEVEL#

Default: INFO

Logging level.

Kafka Configuration#

Tip

AWS Options#

INRUPT_STORAGE_S3_BUCKET_NAME#

Default: inrupt.ess.storage

The name of the S3 bucket used for storage.

QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID#: AWS Access key id.

QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY#: AWS Secret access key.

QUARKUS_S3_AWS_REGION#: An Amazon Web Services region that hosts the S3 Bucket.

QUARKUS_S3_ENDPOINT_OVERRIDE#: Override S3 endpoint URL.

OpenTelemetry Options#

QUARKUS_OPENTELEMETRY_TRACER_EXPORTER_OTLP_ENABLED#

Default: false

The OpenTelemetry exporter can be enabled or disabled with this configuration.

QUARKUS_OPENTELEMETRY_TRACER_EXPORTER_OTLP_ENDPOINT#: The URL of the OpenTelemetry exporter.

Pod Provisioning Service#

Pod Provisioning/Creation#

Default Resource (Extended Profile)#

Initial ACP Policies#

Provisioning Endpoints#

Create a New Pod#

List Pods for a User#

Configuration#

Provision Options#

Solid-OIDC Issuer Configuration Options#

Logging Configuration#

Kafka Configuration#

AWS Options#

OpenTelemetry Options#

Additional Information#