# Pod Provisioning Service ## Pod Provisioning/Creation ESS’ Pod Provisioning Service manages the creation of Pods, using the following URL format: ```none 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](https://docs.inrupt.com/reference/glossary#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 (ACR)](https://docs.inrupt.com/reference/glossary#access-control-resource) is also created for the Pod Root. The ACR is initialized with the default [ACP policies](https://docs.inrupt.com/reference/glossary#access-control-policies) for the Pod Owner and for [Access Grant](https://docs.inrupt.com/reference/glossary#access-grant) enablement: * **Initial Pod Owner 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](https://docs.inrupt.com/ess/2.5/services/service-authorization)’s configuration for the initial client allow list is set: * [**`INRUPT_AUTHORIZATION_DEFAULT_ACR_CLIENT_ID_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_default_acr_client_id_allow_list) or if that is unset, * [**`INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_client_id_allow_list) . {% tabs %} {% tab title="Allow List is Set" %} {% hint style="info" %} ESS uses the values in its [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization)’s [**`INRUPT_AUTHORIZATION_DEFAULT_ACR_CLIENT_ID_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-authorization#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 configuration is unset, ESS uses the values in its [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization)’s [**`INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_client_id_allow_list) (at the time of Pod creation). {% endhint %} 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](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/authentication.md#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](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/authentication.md#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]\(../../../security/authorization/acp.md#member-policies). {% endtab %} {% tab title="Allow List is Not Set" %} {% hint style="info" %} ESS uses the values in its [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization)’s [**`INRUPT_AUTHORIZATION_DEFAULT_ACR_CLIENT_ID_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-authorization#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 configuration is unset, ESS uses the values in its [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization)’s [**`INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_client_id_allow_list) (at the time of Pod creation). {% endhint %} 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](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/authentication.md#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](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/authentication.md#webid), allow Read and Write access. For more information on a Container’s Member Policies, see Member Policies]\(../../../security/authorization/acp.md#member-policies). {% endtab %} {% endtabs %} {% hint style="warning" %} **Disambiguation** Both [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization) and [Pod Storage Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-storage) have a **`INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST`** setting. **Only** the [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization) setting affects which clients are allowed. The [Pod Storage Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-storage) is for [Discovery](https://docs.inrupt.com/ess/2.5/services/service-pod-storage#discovery) purposes only. {% endhint %} * **Initial Access Grant Enablement policies** allow the use of [Access Grants](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/authorization/access-requests-grants/README.md) that grant read/write/append access to the Pod resources. ``` If allOf(VC Matcher) evaluates to true, Then allow (Read and Write and Append). ``` \ Specifically, ESS creates:\ \ **Policy 3 for the Pod Root**:\ If a presented VC matches the specified type, allow its use for\ Read, Write, and Append access.\ \ **Policy 4 for the Pod Root’s Initial Member Policies**:\ If a presented VC matches the specified type, allow its use for Read, Write, and Append access.\ \ See also [**`INRUPT_AUTHORIZATION_DEFAULT_ACR_ACCESS_GRANTS_ALLOWED_MODES`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_default_acr_access_grants_allowed_modes). {% hint style="warning" %} **Important** The policies only enable the use of [Access Grants](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/authorization/access-requests-grants/README.md) for the allowed access modes. To determine the access for an agent using an access grant, ESS uses the *intersection* of: * The allowed access specified by the policy, and * The granted access specified in the Access Grant (for the resource specified in the Access Grant). {% endhint %} {% hint style="info" %} **Note**\ A Pod’s initial Policies are set when the Pod is provisioned. As such, updates to the various **`INRUPT_AUTHORIZATION_DEFAULT_ACR_*`** options do not affect existing Pods. That is, once a Pod’s initial policies have been created, changes to the various **`INRUPT_AUTHORIZATION_DEFAULT_ACR_*`** options are not reflected in that Pod’s policies. {% endhint %} ## Provisioning Endpoints ### Create a New Pod The ESS Pod provisioning service provides an endpoint that client applications can use to create new Pods. {% hint style="warning" %} **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_allow_list) * [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) * [**`INRUPT_STORAGE_MAX_PODS_PER_OWNER`**](#inrupt_storage_max_pods_per_owner) {% endhint %} To create a new Pod (and the [extended profile resource](#default-resource-extended-profile)), 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: ```json { "@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}/" } ```
FieldDescription
@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"
   }
}
idThe WebID of the authenticated user for whom the Pod has been created.
profileThe 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.
storageThe 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](https://docs.inrupt.com/ess/2.5/service-webid#add-pod-location-to-profile-document) 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. {% hint style="warning" %} **Important**\ Access to this endpoint requires users to be authenticated. {% endhint %} 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., ```none [ "/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`**](#inrupt_storage_http_base_url). ## Configuration As part of the [installation process](https://docs.inrupt.com/ess/2.5/installation), 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](https://docs.inrupt.com/ess/installation#step-1-initialize-the-installation-directory). 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. {% hint style="warning" %} **Important** * The value requires a trailing slash **`/`** ; e.g., **`https://storage.{ESS_DOMAIN}/`** . * Ensure that Pod Provision Service’s [**`INRUPT_STORAGE_HTTP_BASE_URL`**](#inrupt_storage_http_base_url) value is consistent with the Pod Storage Service’s [**`INRUPT_STORAGE_HTTP_BASE_URL`**](https://docs.inrupt.com/ess/2.5/services/service-pod-storage#inrupt_storage_http_base_url) value. {% endhint %} #### INRUPT\_STORAGE\_MAX\_PODS\_PER\_OWNER Default : **`10`** *For Pod Provision Service Only* The maximum number of Pods owned by a specific WebID. {% hint style="warning" %} **Important** The [**`INRUPT_STORAGE_MAX_PODS_PER_OWNER`**](#inrupt_storage_max_pods_per_owner) value must equal value must equal [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization)’s [**`INRUPT_AUTHORIZATION_MAX_POD_COUNT`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_max_pod_count) value. When changing the [**`INRUPT_STORAGE_MAX_PODS_PER_OWNER`**](#inrupt_storage_max_pods_per_owner) value, ensure you also update [**`INRUPT_AUTHORIZATION_MAX_POD_COUNT`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_max_pod_count) to the same value. {% endhint %} ### Solid-OIDC Issuer Configuration Options {% hint style="info" %} **Note**\ Whitespaces are **preserved** when parsing comma-delimited lists (i.e., the parsed string values are not trimmed). For example, when parsed, **`"value1, value2,value3 "`** results in **`"value1"`** , **`" value2"`** , **`"value3 "`** . {% endhint %} #### INRUPT\_JWT\_ALLOWED\_SIGNATURE\_ALGORITHMS *Default* : **`ES256`**, **`RS256`** A comma-separated list that specifies the allowed encryption [algorithms](https://www.rfc-editor.org/rfc/rfc7515#section-4.1.1) 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`**](#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`**](#inrupt_jwt_issuer_allow_list) and [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) , the [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) supersedes the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) and the issuer is not accepted by ESS. See also [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list). {% hint style="info" %} **Tip** If your application, such as a start app, provisions the Pod and updates the WebID with the provisioned Pod information, ensure that the WebID service’s [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-webid#inrupt_jwt_issuer_allow_list) overlaps with the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) value set for this service. {% endhint %} #### INRUPT\_JWT\_ISSUER\_DENY\_LIST A comma-separated list of disallowed issuers of Solid-OIDC tokens. * If unset, the service accepts Solid-OIDC tokens from all issuers unless [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) is set, in which case, the service only accepts tokens from those in the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) . * If set, the service disallows the Solid-OIDC tokens from the issuers in the list. If [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) is also set, issuers not in the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) are also disallowed. ### Logging Configuration #### QUARKUS\_LOG\_LEVEL *Default* : **`INFO`** Logging level. ### Kafka Configuration {% hint style="info" %} **Tip**\ See also [ESS’ Kafka Configuration](https://docs.inrupt.com/ess/2.5/services/appendix/appendix-kafka-configuration). {% endhint %} #### INRUPT\_KAFKA\_AUDITV1EVENTSENCRYPTED\_CIPHER\_PASSWORD The strong cipher key to use when running auditing with encrypted messages over the **`auditv1eventsencrypted`** topic. #### INRUPT\_KAFKA\_AUDITV1EVENTSPRODUCERENCRYPTED\_CIPHER\_PASSWORD The strong cipher key to use when running auditing with encrypted messages over the **`auditv1eventsproducerencrypted`** topic. #### INRUPT\_KAFKA\_SOLIDRESOURCE\_CIPHER\_PASSWORD The symmetric key to use when encrypting messages (see [**`MP_MESSAGING_OUTGOING_SOLIDRESOURCE_VALUE_SERIALIZER`**](#mp_messaging_outgoing_solidresource_value_serializer)). #### KAFKA\_BOOTSTRAP\_SERVERS *Default* : **`localhost:9092`** Comma-delimited list of Kafka broker servers for use by ESS services, including this service. Setting [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) configures ESS to use the same Kafka instance(s) for all its Kafka [message channels](https://quarkus.io/guides/kafka#kafka-configuration) (e.g., **`solidresource`** and **`auditv1out`** message channels). The Pod management services use the **`solidresource`** and **`auditv1out`** message channels. {% hint style="info" %} **Note**\ Inrupt-provided overlays default to using [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) . To use a different Kafka instance for the **`solidresource`** and **`auditv1out`** channels, use [**`MP_MESSAGING_OUTGOING_SOLIDRESOURCE_BOOTSTRAP_SERVERS`**](#mp_messaging_outgoing_solidresource_bootstrap_servers) and [**`MP_MESSAGING_OUTGOING_AUDITV1OUT_BOOTSTRAP_SERVERS`**](#mp_messaging_outgoing_auditv1out_bootstrap_servers) instead. {% endhint %} See also [ESS’ Kafka Configuration](https://docs.inrupt.com/ess/2.5/services/appendix/appendix-kafka-configuration). #### MP\_MESSAGING\_OUTGOING\_AUDITV1OUT\_BOOTSTRAP\_SERVERS *Default* : **`localhost:9092`** Comma-delimited list of Kafka broker servers used for the outgoing audit v1 messages. These messages are sent over the **`auditv1out`** [message channel](https://quarkus.io/guides/kafka#kafka-configuration) . {% hint style="info" %} **Note**\ To configure ESS to use the same Kafka instances for all its Kafka message channels, use [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) option instead. Inrupt-provided overlays default to using [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) . {% endhint %} #### MP\_MESSAGING\_OUTGOING\_SOLIDRESOURCE\_BOOTSTRAP\_SERVERS *Default* : **`localhost:9092`** Comma-delimited list of Kafka broker servers used for the outgoing resource notification messages. These messages are sent over the **`solidresource`** [message channel](https://quarkus.io/guides/kafka#kafka-configuration) . {% hint style="info" %} **Note**\ To configure ESS to use the same Kafka instances for all its Kafka message channels, use [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) option instead. Inrupt-provided overlays default to using [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) . {% endhint %} #### MP\_MESSAGING\_OUTGOING\_SOLIDRESOURCE\_VALUE\_SERIALIZER *Default* : **`org.apache.kafka.common.serialization.StringSerializer`** The serializer used for the notification messages the service sends to Kafka. Supported values are: * **`org.apache.kafka.common.serialization.StringSerializer`** * When set to this value, notification messages sent to Kafka are unencrypted. Services that consume these messages (e.g.,[WebSocket Notification Service](https://docs.inrupt.com/ess/2.5/services/service-notification/service-websocket)) will need to set their **`MP_MESSAGING_INCOMING_SOLIDRESOURCE_VALUE_DESERIALIZER`** to the corresponding deserializer value **`org.apache.kafka.common.serialization.StringDeserializer`**. * **`com.inrupt.components.kafka.encryption.EncryptMessageSerializer`** * When set to this value, notification messages sent to Kafka are encrypted. Services that consume these encrypted messages (e.g.,[WebSocket Notification Service](https://docs.inrupt.com/ess/2.5/services/service-notification/service-websocket)) will need to set their **`MP_MESSAGING_INCOMING_SOLIDRESOURCE_VALUE_DESERIALIZER`** configuration to the corresponding deserializer value**`com.inrupt.components.kafka.encryption.DecryptMessageDeserializer`**. ### 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\_OTEL\_EXPORTER\_OTLP\_ENDPOINT The URL to which the OpenTelemetry exporter sends data. #### QUARKUS\_OTEL\_TRACES\_SAMPLER\_ARG *Default* : 0.0d A double compatible value between 0.0d and 1.0d to determine the sampling rate of the OpenTelemetry exporter. A value of 0.0d results in disabling OpenTelemetry exports. ### Configuration Logging ESS services log their startup configuration. #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_ALLOW *Default* : inrupt,smallrye.jwt.expiration.grace,mp.jwt.verify.clock.skew,smallrye.jwt.always-check-authorization,smallrye.jwt.token.decryption.kid,smallrye.jwt.token.schemes,smallrye.jwt.require.named-principal,smallrye.jwt.time-to-live,smallrye.jwt.jwks.refresh-interval,smallrye.jwt.jwks.forced-refresh-interval,smallrye.jwt.required.claims,mp.jwt.verify.audiences A comma-separated list of configuration property prefixes ( **case-sensitive** ) that determine which configurations are logged: * If the list is empty, **NO** configuration property is logged. * If a configuration property starts with a listed prefix ( **case-sensitive** ), the configuration property and its value are logged **unless** the configuration also matches a prefix in [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) (which acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) list).\ As such, if the configuration matches prefix in both [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) , the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) takes precedence and the configuration is not logged. For example, if **`inrupt.`** is an allow prefix, but **`inrupt.kafka.`** is a deny prefix, all configurations that start with **`inrupt.kafka.`** are excluded from the logs. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., **`inrupt.foobar.`** ), or * using the [MicroProfile Config environmental variables conversion value](https://quarkus.io/guides/config-reference#environment-variables) (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="danger" %} Warning\ Use the same format for **both** [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) . For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) as well. {% endhint %} {% hint style="info" %} **Tip**\ To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example: * If using dot-notation, if you want to match configuration properties of the form **`foobar....`** , specify **`foobar.`** (including the dot **`.`** ) instead of, for example, **`foo`** or **`foobar`** . * If using converted form, if you want to match configuration properties of the form **`FOOBAR_...`** , specify **`FOOBAR_`** (including the underscore **`_`** ) instead of, for example, **`FOO`** or **`FOOBAR`** . {% endhint %} #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_DENY *Default* : **`inrupt.kafka`** A comma-separated list of configuration name prefixes ( **case-sensitive** ) that determines which configurations (that would otherwise match the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) ) are not logged. That is, [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) . For example: * If **`foobar.`** is an allowed prefix, to suppress **`foobar.private.`** , you can specify **`foobar.private.`** to the deny list. * If **`foobar.`** is **not** an allowed prefix, no property starting with **`foobar.`** is logged. As such, you do not need to specify **`foobar.private`** to the deny list. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., **`inrupt.foobar.`** ), or * using the [MicroProfile Config environmental variables conversion value](https://quarkus.io/guides/config-reference#environment-variables) (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="danger" %} Warning\ Use the same format for **both** [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) . For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) as well. {% endhint %} ### Logging Redaction #### **INRUPT\_LOGGING\_REDACTION\_NAME\_ACTION** *Default* : **`REPLACE`** Type of the redaction to perform. Supported values are:
ActionDescription
REPLACEDefault. Replaces the matching text with a specified replacement.
PLAINLeaves the matching field unprocessed. Only available if the redaction target is a field (i.e., INRUPT_LOGGING_REDACTION_{NAME}_FIELD)
DROPSuppresses the matching field. Only available if the redaction target is a field (i.e., INRUPT_LOGGING_REDACTION_{NAME}_FIELD).
PRIORITIZEChanges the log level of the matching message.
SHA256Replaces the matching text with its hash.
* If the action is **`REPLACE`** ( *default* ), see also **`INRUPT_LOGGING_REDACTION_{NAME}_REPLACEMENT`** . * If the action is to **`PRIORITIZE`** , see also **`INRUPT_LOGGING_REDACTION_{NAME}_LEVEL`** . For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### **INRUPT\_LOGGING\_REDACTION\_NAME\_ENABLED** *Default* : **`true`** A boolean that determines whether the redaction configurations with the specified **`INRUPT_LOGGING_REDACTION_{NAME}_`** prefix is enabled. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### **INRUPT\_LOGGING\_REDACTION\_NAME\_EXCEPTION** Fully qualified name of the exception class to match in the log messages (includes inner exception). Configure to target an exception message class. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### **INRUPT\_LOGGING\_REDACTION\_NAME\_FIELD** Exact name of the field to match in the log messages. Configure to target a specific log message field for redaction. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### **INRUPT\_LOGGING\_REDACTION\_NAME\_LEVEL** A new log level to use for the log message if the **`INRUPT_LOGGING_REDACTION_{NAME}_ACTION`** is **`PRIORITIZE`** . #### **INRUPT\_LOGGING\_REDACTION\_NAME\_PATTERN** A regex (see [Java regex pattern](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html#sum) ) to match in the log messages. Configure to target log message text that matches a specified pattern. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### **INRUPT\_LOGGING\_REDACTION\_NAME\_REPLACEMENT** Replacement text to use if the **`INRUPT_LOGGING_REDACTION_{NAME}_ACTION`** is **`REPLACE`** . If unspecified, defaults to **`[REDACTED]`** . For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). ### Application-Defined Metadata Propagation #### **INRUPT\_AUDIT\_PRODUCER\_REQUEST\_METADATA\_ALLOW** A comma-separated list of application-defined properties that can be included in the associated [audit events](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/auditing/README.md#audit-event-message-internal-format) (unless specified in the corresponding **`INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY`** ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To include a propagated property that was added via the [`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`](#INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### **INRUPT\_AUDIT\_PRODUCER\_REQUEST\_METADATA\_DENY** A comma-separated list of application-defined properties to exclude from the associated audit messages. This setting takes precedence over [`INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW`](#INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To exclude a propagated property that was added via the [`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`](#INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### **INRUPT\_LOGGING\_REQUEST\_METADATA\_ALLOW** A comma-separated list of application-defined properties that can be included in the associated [log messages](https://docs.inrupt.com/ess/2.5/administration/logging) (unless specified in the corresponding [`INRUPT_LOGGING_REQUEST_METADATA_DENY`](#INRUPT_LOGGING_REQUEST_METADATA_DENY) ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To include a propagated property that was added via the [`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`](#INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### **INRUPT\_LOGGING\_REQUEST\_METADATA\_DENY** A comma-separated list of application-defined properties to exclude from the associated log messages. This setting takes precedence over [`INRUPT_LOGGING_REQUEST_METADATA_ALLOW`](#INRUPT_LOGGING_REQUEST_METADATA_ALLOW) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To exclude a propagated property that was added via the [`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`](#INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### **INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_ALLOW** A comma-separated list of non-baggage request headers to add to the [baggage](https://www.w3.org/TR/baggage/) (unless specified in the corresponding [`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY`](#INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY) ); i.e., include these non-baggage request headers as application-defined properties. The configuration is case-insensitive; i.e., the listed headers do **not** need to match the case of the client request headers. For example, a list that includes **`x-correlation-id`** can match **`x-correlation-id`** header, **`X-CoRrElAtIoN-Id`** header, etc. See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### **INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_DENY** A comma-separated list of non-baggage request headers to exclude from being added to the [baggage](https://www.w3.org/TR/baggage/) ; i.e., excludes these headers as application-defined properties. This setting takes precedence over [`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`](#INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW) . The configuration is case-insensitive; i.e., the listed headers do **not** need to match the case of the client request headers. For example, a list that includes **`x-correlation-id`** can match (and exclude) **`x-correlation-id`** header, **`X-CoRrElAtIoN-Id`** header, etc. See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### **INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_OVERRIDES** A flag that determines ESS behavior when metadata property is defined both as a header and as a baggage entry: * If **`true`** , ESS updates/overrides the baggage entry with the header value. * If **`false`** (the default), ESS keeps the baggage entry. For details, [Duplicate Property Definition](https://docs.inrupt.com/ess/administration/application-defined-metadata#duplicate-property-definition) . #### **INRUPT\_REQUEST\_METADATA\_REFLECTOR\_HEADER\_ALLOW** A comma-separated list of application-defined properties that can return as response headers (unless specified in the corresponding [`INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY`](#INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY) ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip** * To return a propagated property that was added via the [`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`](#INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW) configuration, ensure that the cases of these properties match. * You may need to update **`QUARKUS_HTTP_CORS_EXPOSED_HEADERS`** to extend the list of [CORS-safelisted response headers](https://developer.mozilla.org/en-US/docs/Glossary/CORS-safelisted_response_header) . {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### **INRUPT\_REQUEST\_METADATA\_REFLECTOR\_HEADER\_DENY** A comma-separated list of application-defined properties to exclude from returning as response headers. This setting takes precedence over [`INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW`](#INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To exclude a propagated property that was added via the [`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`](#INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. . ### **Purge Configuration** The Storage service contains user data, and as such it can be purged upon user request. See the [Purger documentation](https://docs.inrupt.com/ess/2.5/services/service-purger) for more information about the data being purged. #### INRUPT\_PURGE\_BATCH\_SIZE *Default* : **`100`** The maximum number of resources that the purge task will purge in each batch. This must be a non-zero, positive integer. {% hint style="info" %} Added in version 2.3.0 {% endhint %} #### INRUPT\_PURGE\_CLEANUP\_TASK\_EVERY *Default* : **`PT5H`** Frequency at which a task goes through stored purge statuses to clear any which are beyond their retention window. {% hint style="info" %} Added in version 2.3.0 {% endhint %} #### INRUPT\_PURGE\_IN\_PROGRESS\_TIMEOUT\_SECONDS *Default* : **`120`** Timeout after which an ongoing purge task is considered stale. Stale tasks are picked up by an ESS background process to be taken to completion. By keeping track of a purge task’s state (active or stale) the service can ensure that a purge which was started will eventually reach completion, even if the system is disrupted whilst the asynchronous purge process is ongoing. {% hint style="info" %} Added in version 2.3.0 {% endhint %} #### INRUPT\_PURGE\_PROCESS\_TASK\_EVERY *Default* : **`PT5M`** Frequency at which an ESS background process goes through ongoing purges to pick up the incomplete stale ones. See **`INRUPT_PURGE_IN_PROGRESS_TIMEOUT_SECONDS`** for additional details. {% hint style="info" %} Added in version 2.3.0 {% endhint %} #### INRUPT\_PURGE\_STATUS\_RETENTION\_WINDOW *Default* : **`P2D`** Duration after which a purge task status will be cleared from storage. The purge task contains some Personally Identifying Data (such as the WebID), so ensuring it is cleared after a purge is required for compliance. {% hint style="info" %} Added in version 2.3.0 {% endhint %} #### INRUPT\_PURGE\_SYSTEM\_STATUS\_ROOT *Default* : **`/system/purge/status/`** The path for storing purge statuses as system resources. {% hint style="info" %} Added in version 2.3.0 {% endhint %} ## Additional Information See also [Quarkus Configuration Options](https://quarkus.io/guides/all-config) .