Skip to content

Commit

Permalink
update generated md config for DP v23.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@rpietzsch
rpietzsch committed Nov 13, 2023
1 parent 17d47dc commit 1d13c7e
Show file tree
Hide file tree
Showing 2 changed files with 193 additions and 31 deletions.
220 changes: 189 additions & 31 deletions docs/deploy-and-configure/configuration/dataplatform/application-full.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Use this property to specify the location of the license file
This section provides general configuration settings.
### Caching
### Configuration of Caching
DataPlatform provides caching support which is enabled by default with an in-memory Caffeine cache.
Expand Down Expand Up @@ -80,6 +80,9 @@ To disable caching, set the type to NONE (not recommended).
| Valid values | string |
| Environment | SPRING_CACHE_INFINISPAN_MODE |
### Configuration of Servlet Container
Multipart upload limits config
You may need to set the following parameter values to 2048MB for implementations
that cannot handle large requests
Expand Down Expand Up @@ -110,56 +113,150 @@ Use this property to define the maximum size of HTTP request in number of bytes.
| Valid values | string |
| Environment | SPRING_SERVLET_MULTIPART_MAX_REQUEST_SIZE |
Spring Cloud configuration
***Property: spring.servlet.multipart.location***
Temporary storage used for multipart upload. This defaults to system property java.io.tmpdir.
| Category | Value |
|--- | ---: |
| Default | *none* |
| Required | false |
| Valid values | string |
| Environment | SPRING_SERVLET_MULTIPART_LOCATION |
***Property: management.info.env.enabled***
***Property: spring.cloud.config.enabled***
| Category | Value |
|--- | ---: |
| Default | true |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_INFO_ENV_ENABLED |
***Property: management.endpoints.web.exposure.include***
| Category | Value |
|--- | ---: |
| Default | * |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE |
***Property: management.endpoints.enabled-by-default***
| Category | Value |
|--- | ---: |
| Default | false |
| Required | false |
| Valid values | string |
| Environment | SPRING_CLOUD_CONFIG_ENABLED |
| Environment | MANAGEMENT_ENDPOINTS_ENABLED_BY_DEFAULT |
Spring Sleuth Zipkin exporter configuration (tracing)
***Property: management.endpoint.health.enabled***
***Property: spring.zipkin.base-url***
| Category | Value |
|--- | ---: |
| Default | true |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_ENDPOINT_HEALTH_ENABLED |
***Property: management.endpoint.health.show-details***
| Category | Value |
|--- | ---: |
| Default | http://localhost:9411/ |
| Default | when_authorized |
| Required | false |
| Valid values | string |
| Environment | SPRING_ZIPKIN_BASE_URL |
| Environment | MANAGEMENT_ENDPOINT_HEALTH_SHOW_DETAILS |
***Property: spring.zipkin.enabled***
***Property: management.endpoint.info.enabled***
| Category | Value |
|--- | ---: |
| Default | true |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_ENDPOINT_INFO_ENABLED |
***Property: management.health.diskspace.enabled***
Whether the export to zipkin is enabled
| Category | Value |
|--- | ---: |
| Default | false |
| Required | false |
| Valid values | string |
| Environment | SPRING_ZIPKIN_ENABLED |
| Environment | MANAGEMENT_HEALTH_DISKSPACE_ENABLED |
***Property: management.health.livenessstate.enabled***
| Category | Value |
|--- | ---: |
| Default | true |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_HEALTH_LIVENESSSTATE_ENABLED |
***Property: management.health.readinessstate.enabled***
| Category | Value |
|--- | ---: |
| Default | true |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_HEALTH_READINESSSTATE_ENABLED |
***Property: management.health.sparql.enabled***
The service name for DataPlatform under which the traces are stored
| Category | Value |
|--- | ---: |
| Default | true |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_HEALTH_SPARQL_ENABLED |
***Property: management.health.sparql.fixedDelayInMilliseconds***
| Category | Value |
|--- | ---: |
| Default | 5000 |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_HEALTH_SPARQL_FIXEDDELAYINMILLISECONDS |
***Property: spring.zipkin.service.name***
***Property: management.health.sparql.timeoutInMilliseconds***
| Category | Value |
|--- | ---: |
| Default | DP |
| Default | 5000 |
| Required | false |
| Valid values | string |
| Environment | SPRING_ZIPKIN_SERVICE_NAME |
| Environment | MANAGEMENT_HEALTH_SPARQL_TIMEOUTINMILLISECONDS |
Spring Cloud Sleuth distributed tracing. This generated IDs for queries/updates and all operations in DataPlatform. Write to tracing exporter s. spring.zipkin.
***Property: management.influx.metrics.export.enabled***
***Property: spring.sleuth.enabled***
| Category | Value |
|--- | ---: |
| Default | false |
| Required | false |
| Valid values | string |
| Environment | MANAGEMENT_INFLUX_METRICS_EXPORT_ENABLED |
Activate Micrometer Tracing capability (https://micrometer.io/docs/tracing) with Brave (https://github.com/openzipkin/brave)
***Property: management.tracing.enabled***
Whether tracing is enabled. If not then IDs for i.e. queries are generated via UUID mechanism. Backend store "neptune" is not compatible with tracing enabled.
Expand All @@ -168,7 +265,7 @@ Whether tracing is enabled. If not then IDs for i.e. queries are generated via U
| Default | true |
| Required | false |
| Valid values | string |
| Environment | SPRING_SLEUTH_ENABLED |
| Environment | MANAGEMENT_TRACING_ENABLED |
## OpenAPI Specification and Swagger UI
Expand Down Expand Up @@ -418,19 +515,6 @@ Use this property to configure the URI of the public user (see section Public ac
| Valid values | string |
| Environment | AUTHORIZATION_ABOX_ANONYMOUSUSER |
***Property: authorization.abox.prefix***
Use this property to set the namespace of URIs created by DataPlatform.
**Note:** If you change this property, you also need to change the corresponding shape definitions for access conditions (more precisely, the URI template), as well as existing URI descriptions and existing access conditions.
| Category | Value |
|--- | ---: |
| Default | https://ns.eccenca.com/ |
| Required | false |
| Valid values | string |
| Environment | AUTHORIZATION_ABOX_PREFIX |
#### Access conditions
**IMPORTANT:** The following properties are deprecated and have no function anymore!
Expand Down Expand Up @@ -628,6 +712,69 @@ Used for resolving titles & comments and loading shaped resources.
| Valid values | RESOURCE_IN_VALUES, FILTER_ONLY |
| Environment | PROXY_FETCHVALUESSTRATEGY |

## LLM Assistant Supported

Leverage generative AI (LLMs) for ontology creation and exploration (SPARQL query generation).


***Property: assist.enabled***

Activate LLM Assistant features.

| Category | Value |
|--- | ---: |
| Default | false |
| Required | false |
| Valid values | boolean |
| Environment | ASSIST_ENABLED |

***Property: assist.openAiApiKey***

Your OpenAI API key to use.

| Category | Value |
|--- | ---: |
| Default | *none* |
| Required | true |
| Valid values | string |
| Environment | ASSIST_OPENAIAPIKEY |

***Property: assist.baseUrl***

The access token URL for the LLM API. Used to configure an openAI API compatible alternative service (e.g. OpenAI in MS Azure). If empty OpenAI API will be used.


| Category | Value |
|--- | ---: |
| Default | *none* |
| Required | false |
| Valid values | string |
| Environment | ASSIST_BASEURL |

***Property: assist.chatModel***

The name of the model to use for chat interactions. Defaults to "gpt-3.5-turbo-16k-0613". Use of a `*-0613` model (fine tuned for function calling) is recommended.


| Category | Value |
|--- | ---: |
| Default | gpt-3.5-turbo-16k-0613 |
| Required | false |
| Valid values | string |
| Environment | ASSIST_CHATMODEL |

***Property: assist.embeddingModel***

The name of the model to use for retrieving embeddings. Defaults to "text-embedding-ada-002".


| Category | Value |
|--- | ---: |
| Default | text-embedding-ada-002 |
| Required | false |
| Valid values | string |
| Environment | ASSIST_EMBEDDINGMODEL |

## Syncing graph via git repositories

DataPlatform can sync graphs between git repositories and the backend store.
Expand Down Expand Up @@ -1189,6 +1336,17 @@ Stored files and saved analysis will be deleted if older than maintenanceExpirat
| Valid values | string |
| Environment | FILES_MAINTENANCEEXPIRATIONDURATION |

***Property: files.storageDirectory***

A folder where the storage service places the files for later analysis and upload to the store. The folder is cleansed regularly. A temp folder (java.io.tmpdir) is created and used if not set.

| Category | Value |
|--- | ---: |
| Default | *none* |
| Required | false |
| Valid values | string |
| Environment | FILES_STORAGEDIRECTORY |

## Store configuration

Store properties for connecting to a triple store backend. Please see specific sections in documentation for each backend.
Expand Down
4 changes: 4 additions & 0 deletions docs/deploy-and-configure/configuration/dataplatform/application-neptune-full.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ uploaded via S3 based bulk loader. The S3 bucket is accessed in this case via an
role CMEM runs under has write access to the bucket. One of the role the neptune cluster runs under is configured in this setting and has read access to the bucket.
On bulk load the loading runs parallel in the setting HIGH which causes higher cpu load but better performance.

Also the example disables DPs generation of tracing IDs by micrometer tracing - Neptune needs UUIDs as IDs for queries etc.

```yaml
store:
type: neptune
Expand All @@ -24,6 +26,8 @@ store:
iamRoleArn: "arn:aws:iam::887770733838:role/NeptuneLoadFromS3"
bulkLoadThresholdInMb: 100
bulkLoadParallelism: HIGH

management.tracing.enabled: false
```
Expand Down

0 comments on commit 1d13c7e

Please sign in to comment.