VDI Plugin Configuration Schema

Type: object

root vdi

VDI Configuration Schema

Type: object
No Additional Properties

root vdi cacheDb
Type: object

root vdi cacheDb server

root vdi cacheDb server oneOf Host Address String

Host Address String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}(?::|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?$
Examples:

something:8080

foo.com:1234

portless.host.string
root vdi cacheDb server oneOf Address Config Object

Address Config Object

Type: object

Examples:

host: abc.def.com
port: 1234

host: abc.def.com

root vdi cacheDb server oneOf Address Config Object host

Hostname String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}$)([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)$

Must be at least 1 characters long

Must be at most 253 characters long

root vdi cacheDb server oneOf Address Config Object port

Connection Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root vdi cacheDb username
Type: string

Must be at least 3 characters long

root vdi cacheDb password
Type: string

Must be at least 3 characters long

root vdi cacheDb name
Type: string Default: "vdi"

Must be at least 3 characters long

root vdi cacheDb poolSize
Type: integer Default: 5

Value must be greater or equal to 1 and lesser or equal to 32

root vdi restService

VDI Rest Service Config

Type: object

root vdi restService maxUploadSize

Max Dataset Upload Size

Type: integer Default: 1073741824

Maximum allowed size, in bytes, for an individual dataset data upload request.

Defaults to 1GiB.

Value must be greater or equal to 1048576

root vdi restService userMaxStorageSize

Max User Storage Quota

Type: integer Default: 10737418240

Maximum allowed total storage usage, in bytes, for raw user upload files.

Defaults to 10GiB

Value must be greater or equal to 1073741824

root vdi restService enableJerseyTrace

Enable Trace Response Headers

Type: boolean Default: false

root vdi daemons
Type: object
No Additional Properties

root vdi daemons eventRouter

Object Store Event Demuxer Config

Type: object
No Additional Properties

root vdi daemons eventRouter kafkaProducerId

Kafka Producer ID

Type: string Default: "event-router"

Identifier the event router will announce itself with when publishing events to Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi daemons pruner

Dataset Pruner Config

Type: object
No Additional Properties

root vdi daemons pruner retentionWindow

Deleted Dataset Retention Window

Type: string Default: "30d"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi daemons pruner pruneInterval

Pruning Interval

Type: string Default: "6h"

Interval at which the dataset pruner will prune deleted datasets that have been marked as deleted for longer than the configured retention window.

 Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi daemons pruner wakeInterval

Wakeup Interval

Type: string Default: "2s"

Interval at which the pruner will wake up and check for a service shutdown signal.

 Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi daemons reconciler

Dataset Reconciler Config

Type: object
No Additional Properties

root vdi daemons reconciler enabled

Enable Automatic Reconciliation

Type: boolean Default: true

Whether the reconciler daemon should be active.
For developing or running locally against a shared install-target, this should likely be set to false to avoid accidentally breaking other developers' test data.

root vdi daemons reconciler fullRunInterval

Full Reconciliation Interval

Type: string Default: "6h"

Interval at which a full synchronization of all dataset install targets will be performed.

 Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi daemons reconciler slimRunInterval

Slim Reconciliation Interval

Type: string Default: "5m"

Interval at which a synchronization of the internal cache database will be executed. This is needed to accommodate for MinIO lacking the S3 event-on-replication feature.

 Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi daemons reconciler performDeletes

Uninstall Missing Datasets

Type: boolean Default: true

Whether the reconciler should attempt to uninstall datasets that are absent from the object store.
When testing or running locally against a shared install-target, this should be set to false to avoid breaking other developers' test data.

root vdi kafka

Kafka Configuration

Type: object
No Additional Properties

root vdi kafka servers
Type: array
No Additional Items

Each item of this array must be:

root vdi kafka servers servers items

root vdi kafka servers servers items oneOf Host Address String

Host Address String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}(?::|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?$
Examples:

something:8080

foo.com:1234

portless.host.string
root vdi kafka servers servers items oneOf Address Config Object

Address Config Object

Type: object

Examples:

host: abc.def.com
port: 1234

host: abc.def.com

root vdi kafka servers servers items oneOf Address Config Object host

Hostname String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}$)([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)$

Must be at least 1 characters long

Must be at most 253 characters long

root vdi kafka servers servers items oneOf Address Config Object port

Connection Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root vdi kafka consumers
Type: object
No Additional Properties

root vdi kafka consumers autoCommitInterval

Duration String

Type: string Default: "5s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers autoOffsetReset
Type: enum (of string) Default: "earliest"

Must be one of:

  • "earliest"
  • "latest"
  • "none"

root vdi kafka consumers connectionsMaxIdle

Duration String

Type: string Default: "9m"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers groupId
Type: string Default: "vdi-kafka-consumers"

root vdi kafka consumers groupInstanceId
Type: string Default: null

root vdi kafka consumers defaultApiTimeout

Duration String

Type: string Default: "1m"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers enableAutoCommit
Type: boolean Default: true

root vdi kafka consumers fetchMaxBytes
Type: integer Default: 52428800

Value must be greater or equal to 0

root vdi kafka consumers fetchMinBytes
Type: integer Default: 1

Value must be greater or equal to 0

root vdi kafka consumers heartbeatInterval

Duration String

Type: string Default: "3s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers maxPollInterval

Duration String

Type: string Default: "5m"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers maxPollRecords
Type: integer Default: 500

Value must be greater or equal to 0

root vdi kafka consumers pollDuration

Duration String

Type: string Default: "2s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers receiveBufferSize
Type: integer Default: 65536

Value must be greater or equal to -1

root vdi kafka consumers reconnectBackoffMaxTime

Duration String

Type: string Default: "1s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers reconnectBackoffTime

Duration String

Type: string Default: "50ms"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers requestTimeout

Duration String

Type: string Default: "30s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers retryBackoffTime

Duration String

Type: string Default: "100ms"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka consumers sendBufferSize
Type: integer Default: 131072

Value must be greater or equal to -1

root vdi kafka consumers sessionTimeout

Duration String

Type: string Default: "45s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka producers
Type: object
No Additional Properties

root vdi kafka producers bufferMemory
Type: integer Default: 33554432

Value must be greater or equal to 0

root vdi kafka producers compressionType
Type: enum (of string) Default: "none"

Must be one of:

  • "none"
  • "gzip"
  • "snappy"
  • "lz4"
  • "zstd"

root vdi kafka producers sendRetries
Type: integer Default: 2147483647

Value must be greater or equal to 0 and lesser or equal to 2147483647

root vdi kafka producers batchSize
Type: integer Default: 16384

Value must be greater or equal to 0

root vdi kafka producers connectionsMaxIdle

Duration String

Type: string Default: "9m"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka producers deliveryTimeout

Duration String

Type: string Default: "2m"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka producers lingerTime

Duration String

Type: string Default: "5ms"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka producers maxBlockingTimeout

Duration String

Type: string Default: "1m"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka producers maxRequestSize
Type: integer Default: 1048576

Value must be greater or equal to 0

root vdi kafka producers receiveBufferSize
Type: integer Default: 32768

Value must be greater or equal to -1

root vdi kafka producers requestTimeout

Duration String

Type: string Default: "30s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka producers sendBufferSize
Type: integer Default: 131072

Value must be greater or equal to -1

root vdi kafka producers reconnectBackoffMaxTime

Duration String

Type: string Default: "1s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka producers reconnectBackoffTime

Duration String

Type: string Default: "50ms"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi kafka producers retryBackoffTime

Duration String

Type: string Default: "100ms"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi lanes
Type: object

root vdi lanes hardDelete

Hard Delete Lane Config

Type: object

root vdi lanes hardDelete kafkaConsumerId

Kafka Consumer ID

Type: string Default: "hard-delete-lane-receive"

Name the lane will identify itself with when fetching events from Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes hardDelete inMemoryQueueSize

In-Memory Job Queue Size

Type: integer Default: 10

Number of jobs that should be pulled from the event channel and kept in memory for processing. If there is a service shutdown, the in-memory jobs may be lost and need to be re-queued by the reconciler.

Value must be greater or equal to 1 and lesser or equal to 100

root vdi lanes hardDelete workerCount

Worker Count

Type: integer Default: 10

Number of worker coroutines that should be actively processing events.

Value must be greater or equal to 1 and lesser or equal to 20

root vdi lanes hardDelete eventChannel

Event Channel Name

Type: string Default: "hard-delete-triggers"

Name of the event channel (topic) the lane will subscribe to.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes hardDelete eventKey

Event Message Key

Type: string Default: "hard-delete-trigger"

Message key used to filter events.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes import

Data Preprocessing Lane Config

Type: object

root vdi lanes import kafkaConsumerId

Kafka Consumer ID

Type: string Default: "import-lane-receive"

Name the lane will identify itself with when fetching events from Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes import inMemoryQueueSize

In-Memory Job Queue Size

Type: integer Default: 10

Number of jobs that should be pulled from the event channel and kept in memory for processing. If there is a service shutdown, the in-memory jobs may be lost and need to be re-queued by the reconciler.

Value must be greater or equal to 1 and lesser or equal to 100

root vdi lanes import workerCount

Worker Count

Type: integer Default: 10

Number of worker coroutines that should be actively processing events.

Value must be greater or equal to 1 and lesser or equal to 20

root vdi lanes import eventChannel

Event Channel Name

Type: string Default: "import-triggers"

Name of the event channel (topic) the lane will subscribe to.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes import eventKey

Event Message Key

Type: string Default: "import-trigger"

Message key used to filter events.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes install

Data Installation Lane Config

Type: object

root vdi lanes install kafkaConsumerId

Kafka Consumer ID

Type: string Default: "install-data-lane-receive"

Name the lane will identify itself with when fetching events from Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes install inMemoryQueueSize

In-Memory Job Queue Size

Type: integer Default: 5

Number of jobs that should be pulled from the event channel and kept in memory for processing. If there is a service shutdown, the in-memory jobs may be lost and need to be re-queued by the reconciler.

Value must be greater or equal to 1 and lesser or equal to 100

root vdi lanes install workerCount

Worker Count

Type: integer Default: 5

Number of worker coroutines that should be actively processing events.

Value must be greater or equal to 1 and lesser or equal to 20

root vdi lanes install eventChannel

Event Channel Name

Type: string Default: "install-triggers"

Name of the event channel (topic) the lane will subscribe to.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes install eventKey

Event Message Key

Type: string Default: "install-trigger"

Message key used to filter events.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes reconciliation

Dataset Reconciliation Lane Config

Type: object

root vdi lanes reconciliation kafkaConsumerId

Kafka Consumer ID

Type: string Default: "reconciliation-lane-receive"

Name the lane will identify itself with when fetching events from Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes reconciliation kafkaProducerId

Kafka Producer ID

Type: string Default: "reconciliation-lane-send"

Name the lane will identify itself with when publishing events to Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes reconciliation inMemoryQueueSize

In-Memory Job Queue Size

Type: integer Default: 10

Number of jobs that should be pulled from the event channel and kept in memory for processing. If there is a service shutdown, the in-memory jobs may be lost and need to be re-queued by the reconciler.

Value must be greater or equal to 1 and lesser or equal to 100

root vdi lanes reconciliation workerCount

Worker Count

Type: integer Default: 10

Number of worker coroutines that should be actively processing events.

Value must be greater or equal to 1 and lesser or equal to 20

root vdi lanes reconciliation eventChannel

Event Channel Name

Type: string Default: "reconciliation-triggers"

Name of the event channel (topic) the lane will subscribe to.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes reconciliation eventKey

Event Message Key

Type: string Default: "reconciliation-trigger"

Message key used to filter events.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes sharing

Dataset Share Lane Config

Type: object

root vdi lanes sharing kafkaConsumerId

Kafka Consumer ID

Type: string Default: "share-lane-receive"

Name the lane will identify itself with when fetching events from Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes sharing inMemoryQueueSize

In-Memory Job Queue Size

Type: integer Default: 10

Number of jobs that should be pulled from the event channel and kept in memory for processing. If there is a service shutdown, the in-memory jobs may be lost and need to be re-queued by the reconciler.

Value must be greater or equal to 1 and lesser or equal to 100

root vdi lanes sharing workerCount

Worker Count

Type: integer Default: 10

Number of worker coroutines that should be actively processing events.

Value must be greater or equal to 1 and lesser or equal to 20

root vdi lanes sharing eventChannel

Event Channel Name

Type: string Default: "share-triggers"

Name of the event channel (topic) the lane will subscribe to.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes sharing eventKey

Event Message Key

Type: string Default: "share-trigger"

Message key used to filter events.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes softDelete

Soft Delete Lane Config

Type: object

root vdi lanes softDelete kafkaConsumerId

Kafka Consumer ID

Type: string Default: "soft-delete-lane-receive"

Name the lane will identify itself with when fetching events from Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes softDelete inMemoryQueueSize

In-Memory Job Queue Size

Type: integer Default: 5

Number of jobs that should be pulled from the event channel and kept in memory for processing. If there is a service shutdown, the in-memory jobs may be lost and need to be re-queued by the reconciler.

Value must be greater or equal to 1 and lesser or equal to 100

root vdi lanes softDelete workerCount

Worker Count

Type: integer Default: 5

Number of worker coroutines that should be actively processing events.

Value must be greater or equal to 1 and lesser or equal to 20

root vdi lanes softDelete eventChannel

Event Channel Name

Type: string Default: "soft-delete-triggers"

Name of the event channel (topic) the lane will subscribe to.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes softDelete eventKey

Event Message Key

Type: string Default: "soft-delete-trigger"

Message key used to filter events.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes updateMeta

Dataset Metadata Upsert Lane Config

Type: object

root vdi lanes updateMeta kafkaConsumerId

Kafka Consumer ID

Type: string Default: "update-meta-lane-receive"

Name the lane will identify itself with when fetching events from Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes updateMeta kafkaProducerId

Kafka Producer ID

Type: string Default: "update-meta-lane-send"

Name the lane will identify itself with when publishing events to Kafka.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes updateMeta inMemoryQueueSize

In-Memory Job Queue Size

Type: integer Default: 5

Number of jobs that should be pulled from the event channel and kept in memory for processing. If there is a service shutdown, the in-memory jobs may be lost and need to be re-queued by the reconciler.

Value must be greater or equal to 1 and lesser or equal to 100

root vdi lanes updateMeta workerCount

Worker Count

Type: integer Default: 5

Number of worker coroutines that should be actively processing events.

Value must be greater or equal to 1 and lesser or equal to 20

root vdi lanes updateMeta eventChannel

Event Channel Name

Type: string Default: "update-meta-triggers"

Name of the event channel (topic) the lane will subscribe to.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi lanes updateMeta eventKey

Event Message Key

Type: string Default: "update-meta-trigger"

Message key used to filter events.

Must be at least 3 characters long

Must be at most 32 characters long

root vdi ldap

LDAP Connection Configuration

Type: object

root vdi ldap servers

LDAP Server List


List of servers that container core will use to lookup database details. Servers will be tried in the order they are defined.

root vdi ldap servers oneOf Host Strings

Host Strings

Type: array
No Additional Items

Each item of this array must be:

root vdi ldap servers oneOf Host Strings Host Address String

Host Address String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}(?::|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?$
Examples:

something:8080

foo.com:1234

portless.host.string
root vdi ldap servers oneOf Host Details

Host Details

Type: array
No Additional Items

Each item of this array must be:

root vdi ldap servers oneOf Host Details Address Config Object

Address Config Object

Type: object

Examples:

host: abc.def.com
port: 1234

host: abc.def.com

root vdi ldap servers oneOf Host Details Address Config Object host

Hostname String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}$)([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)$

Must be at least 1 characters long

Must be at most 253 characters long

root vdi ldap servers oneOf Host Details Address Config Object port

Connection Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root vdi ldap servers oneOf Comma Separated Address List

Comma Separated Address List

Type: string
Must match regular expression: ^(?:(?=[\da-zA-Z.-]{1,253}(?::|,|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?(?:,(?=.+)|$))+$
Examples:

something:8080,foo.com

foo.com,apple-service:9001

root vdi ldap baseDn
Type: string

root vdi objectStore

Object Store Connection Config

Type: object
No Additional Properties

root vdi objectStore bucketName
Type: string

root vdi objectStore server

root vdi objectStore server oneOf Host Address String

Host Address String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}(?::|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?$
Examples:

something:8080

foo.com:1234

portless.host.string
root vdi objectStore server oneOf Address Config Object

Address Config Object

Type: object

Examples:

host: abc.def.com
port: 1234

host: abc.def.com

root vdi objectStore server oneOf Address Config Object host

Hostname String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}$)([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)$

Must be at least 1 characters long

Must be at most 253 characters long

root vdi objectStore server oneOf Address Config Object port

Connection Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root vdi objectStore https
Type: boolean Default: true

root vdi objectStore accessToken
Type: string

Must be at least 3 characters long

root vdi objectStore secretKey
Type: string

Must be at least 8 characters long

root vdi plugins
Type: object

Each additional property must conform to the following schema

root vdi plugins VDI Plugin Config

VDI Plugin Config

Type: object
No Additional Properties

root vdi plugins VDI Plugin Config server

root vdi plugins VDI Plugin Config server oneOf Host Address String

Host Address String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}(?::|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?$
Examples:

something:8080

foo.com:1234

portless.host.string
root vdi plugins VDI Plugin Config server oneOf Address Config Object

Address Config Object

Type: object

Examples:

host: abc.def.com
port: 1234

host: abc.def.com

root vdi plugins VDI Plugin Config server oneOf Address Config Object host

Hostname String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}$)([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)$

Must be at least 1 characters long

Must be at most 253 characters long

root vdi plugins VDI Plugin Config server oneOf Address Config Object port

Connection Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root vdi plugins VDI Plugin Config dataTypes

Data Types

Type: array

Types and versions of dataset data handled by the plugin being defined.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root vdi plugins VDI Plugin Config dataTypes vdi;plugin.json;dataType
Type: object

root vdi plugins VDI Plugin Config typeChangesEnabled
Type: boolean Default: false

Whether datasets can be revised from this data type to another.

root vdi plugins VDI Plugin Config customPath

PATH Extension

Type: string

Allows adding additional paths to the PATH environment variable passed to plugin scripts on execution in the typical colon (:) divided format.
Leading or trailing colon characters are not required.
Example:

/opt/something/bin:/opt/other/bin

root vdi plugins VDI Plugin Config installRoot

Dataset File Install Root

Type: stringFormat: uri-reference Default: "/datasets"

The root mount path INSIDE THE CONTAINER which will contain the site build directory hierarchy into which dataset files will be installed. The build directory itself MUST NOT be part of this path.
Example:

/datasets

root vdi plugins VDI Plugin Config projectIds
Type: array
No Additional Items

Each item of this array must be:

root vdi plugins VDI Plugin Config projectIds Dataset Installation Target

Dataset Installation Target

Type: enum (of string)

Must be one of:

  • "AmoebaDB"
  • "ClinEpiDB"
  • "CryptoDB"
  • "FungiDB"
  • "GiardiaDB"
  • "HostDB"
  • "MicrobiomeDB"
  • "MicrosporidiaDB"
  • "OrthoMCL"
  • "PiroplasmaDB"
  • "PlasmoDB"
  • "ToxoDB"
  • "TrichDB"
  • "TriTrypDB"
  • "VectorBase"
  • "VEuPathDB"

root vdi plugins VDI Plugin Config scripts
Type: object
No Additional Properties

root vdi plugins VDI Plugin Config scripts checkCompatibility

Data Compatibility Test

Type: object
No Additional Properties

root vdi plugins VDI Plugin Config scripts checkCompatibility maxDuration

Maximum Script Execution Time

Type: string
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi plugins VDI Plugin Config scripts checkCompatibility pathOverride

Script Path Override

Type: string

Example:

/opt/vpdb/bin/import.sh

root vdi plugins VDI Plugin Config scripts dataCleaning

Data Import/Cleanup

Type: object
No Additional Properties

root vdi plugins VDI Plugin Config scripts dataCleaning maxDuration

Maximum Script Execution Time

Type: string
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi plugins VDI Plugin Config scripts dataCleaning pathOverride

Script Path Override

Type: string

Example:

/opt/vpdb/bin/import.sh

root vdi plugins VDI Plugin Config scripts dataInstall

Data Installation

Type: object
No Additional Properties

root vdi plugins VDI Plugin Config scripts dataInstall maxDuration

Maximum Script Execution Time

Type: string
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi plugins VDI Plugin Config scripts dataInstall pathOverride

Script Path Override

Type: string

Example:

/opt/vpdb/bin/import.sh

root vdi plugins VDI Plugin Config scripts metaUpdate

Dataset Metadata Upsert

Type: object
No Additional Properties

root vdi plugins VDI Plugin Config scripts metaUpdate maxDuration

Maximum Script Execution Time

Type: string
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi plugins VDI Plugin Config scripts metaUpdate pathOverride

Script Path Override

Type: string

Example:

/opt/vpdb/bin/import.sh

root vdi plugins VDI Plugin Config scripts uninstall

Dataset Uninstallation

Type: object
No Additional Properties

root vdi plugins VDI Plugin Config scripts uninstall maxDuration

Maximum Script Execution Time

Type: string
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi plugins VDI Plugin Config scripts uninstall pathOverride

Script Path Override

Type: string

Example:

/opt/vpdb/bin/import.sh

root vdi rabbit
Type: object
No Additional Properties

root vdi rabbit global

RabbitMQ Configuration

Type: object
No Additional Properties

root vdi rabbit global pollInterval

Duration String

Type: string Default: "1s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi rabbit global connection
Type: object
No Additional Properties

root vdi rabbit global connection name

Connection Name

Type: string Default: "vdi"

Used in RabbitMQ error logging in the RabbitMQ instance as well as the RabbitMQ Java library.

root vdi rabbit global connection server

RabbitMQ Server Details


Port defaults to 5671 with TLS enabled, or 5672 with TLS disabled.

root vdi rabbit global connection server oneOf Host Address String

Host Address String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}(?::|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?$
Examples:

something:8080

foo.com:1234

portless.host.string
root vdi rabbit global connection server oneOf Address Config Object

Address Config Object

Type: object

Examples:

host: abc.def.com
port: 1234

host: abc.def.com

root vdi rabbit global connection server oneOf Address Config Object host

Hostname String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}$)([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)$

Must be at least 1 characters long

Must be at most 253 characters long

root vdi rabbit global connection server oneOf Address Config Object port

Connection Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535


Examples:

rabbit.site.com

rabbit.site.com:5671

host: rabbit.site.com

host: rabbit.site.com
port: '5672'

root vdi rabbit global connection username
Type: string

Must be at least 3 characters long

root vdi rabbit global connection password
Type: string

Must be at least 3 characters long

root vdi rabbit global connection tls
Type: boolean Default: true

root vdi rabbit global connection timeout

Duration String

Type: string Default: "10s"
Must match regular expression: ^(?=.{2,})((?:\d+d)? ?(?:(?<!\S)\d+h)? ?(?:(?<!\S)\d+m)? ?(?:(?<!\S)\d+(?:\.\d+s$|s))? ?(?:(?<!\S)\d+(?:\.\d+ms$|ms))? ?(?:(?<!\S)\d+(?:\.\d+us$|us))? ?(?:(?<!\S)\d+ns)?)$
Examples:

1d 12h 32m 30.340s

12s

1h 22us 5ns

root vdi rabbit global exchange
Type: object
No Additional Properties

root vdi rabbit global exchange name
Type: string

Must be at least 3 characters long

root vdi rabbit global exchange type
Type: enum (of string) Default: "direct"

Must be one of:

  • "direct"
  • "fanout"
  • "topic"

root vdi rabbit global exchange autoDelete
Type: boolean Default: false

root vdi rabbit global exchange durable
Type: boolean Default: true

root vdi rabbit global exchange arguments
Type: object

Each additional property must conform to the following schema

root vdi rabbit global exchange arguments additionalProperties
Type: string

root vdi rabbit global queue
Type: object
No Additional Properties

root vdi rabbit global queue name
Type: string

Must be at least 3 characters long

root vdi rabbit global queue autoDelete
Type: boolean Default: false

root vdi rabbit global queue durable
Type: boolean Default: true

root vdi rabbit global queue exclusive
Type: boolean Default: false

root vdi rabbit global queue arguments
Type: object

Each additional property must conform to the following schema

root vdi rabbit global queue arguments additionalProperties
Type: string

root vdi rabbit global routing
Type: object
No Additional Properties

root vdi rabbit global routing key
Type: string

Must be at least 3 characters long

root vdi rabbit global routing arguments
Type: object

Each additional property must conform to the following schema

root vdi rabbit global routing arguments additionalProperties
Type: string

root vdi siteBuild

Site Build Directory Name

Type: string

Name of the parent directory containing the per-project dataset files subdirectories.

This directory name will be used to form paths such as {siteBuild}/{installTarget}/{datasetId}.
Example:

build-65

root vdi installTargets

Dataset Installation Targets

Type: array

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root vdi installTargets Dataset Installation Target

Dataset Installation Target

Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root vdi installTargets Dataset Installation Target if

root vdi installTargets Dataset Installation Target if oneOf Explicitly Enabled

Explicitly Enabled

Type: object

The enabled field is explicitly set to true.

root vdi installTargets Dataset Installation Target if oneOf Enabled by Default

Enabled by Default


The enabled field is omitted, using the default value of true.

Must not be:

root vdi installTargets Dataset Installation Target if oneOf Enabled by Default not
Type: object
root vdi installTargets Dataset Installation Target then
Type: object

The following properties are required:

  • targetName

root vdi installTargets Dataset Installation Target then controlDb

Database Connection Config

Type: object

root vdi installTargets Dataset Installation Target then controlDb allOf Basic Options

Basic Options

Type: object

root vdi installTargets Dataset Installation Target then controlDb allOf Basic Options username
Type: string

Must be at least 3 characters long

root vdi installTargets Dataset Installation Target then controlDb allOf Basic Options password
Type: string

Must be at least 8 characters long

root vdi installTargets Dataset Installation Target then controlDb allOf Basic Options poolSize
Type: integer Default: 5

Value must be greater or equal to 5 and lesser or equal to 32

root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details

Connection Details


root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details oneOf LDAP Common Name

LDAP Common Name

Type: object

root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details oneOf Direct Connection Config

Direct Connection Config

Type: object

root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details oneOf Direct Connection Config server

Database Host Details


root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details oneOf Direct Connection Config server oneOf Host Address String

Host Address String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}(?::|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?$
Examples:

something:8080

foo.com:1234

portless.host.string
root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details oneOf Direct Connection Config server oneOf Address Config Object

Address Config Object

Type: object

Examples:

host: abc.def.com
port: 1234

host: abc.def.com

root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details oneOf Direct Connection Config server oneOf Address Config Object host

Hostname String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}$)([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)$

Must be at least 1 characters long

Must be at most 253 characters long

root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details oneOf Direct Connection Config server oneOf Address Config Object port

Connection Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root vdi installTargets Dataset Installation Target then controlDb allOf Connection Details oneOf Direct Connection Config platform
Type: enum (of string) Default: null

Must be one of:

  • "oracle"
  • "postgres"

root vdi installTargets Dataset Installation Target then dataDb

Database Connection Config

Type: object

root vdi installTargets Dataset Installation Target then dataDb allOf Basic Options

Basic Options

Type: object

root vdi installTargets Dataset Installation Target then dataDb allOf Basic Options username
Type: string

Must be at least 3 characters long

root vdi installTargets Dataset Installation Target then dataDb allOf Basic Options password
Type: string

Must be at least 8 characters long

root vdi installTargets Dataset Installation Target then dataDb allOf Basic Options poolSize
Type: integer Default: 5

Value must be greater or equal to 5 and lesser or equal to 32

root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details

Connection Details


root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details oneOf LDAP Common Name

LDAP Common Name

Type: object

root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details oneOf Direct Connection Config

Direct Connection Config

Type: object

root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details oneOf Direct Connection Config server

Database Host Details


root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details oneOf Direct Connection Config server oneOf Host Address String

Host Address String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}(?::|$))([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)(?::([1-9]\d{0,3}|[1-5]\d{4}|6(?:[0-4]\d{3}|5(?:[0-4]\d{2}|5(?:[0-2]\d|3[0-5])))))?$
Examples:

something:8080

foo.com:1234

portless.host.string
root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details oneOf Direct Connection Config server oneOf Address Config Object

Address Config Object

Type: object

Examples:

host: abc.def.com
port: 1234

host: abc.def.com

root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details oneOf Direct Connection Config server oneOf Address Config Object host

Hostname String

Type: string
Must match regular expression: ^(?=[\da-zA-Z.-]{1,253}$)([\da-zA-Z][\da-zA-Z-]{0,62}(?:\.[\da-zA-Z][\da-zA-Z-]{0,62})*)$

Must be at least 1 characters long

Must be at most 253 characters long

root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details oneOf Direct Connection Config server oneOf Address Config Object port

Connection Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

root vdi installTargets Dataset Installation Target then dataDb allOf Connection Details oneOf Direct Connection Config platform
Type: enum (of string) Default: null

Must be one of:

  • "oracle"
  • "postgres"

root vdi installTargets Dataset Installation Target enabled

Enabled

Type: boolean Default: true

Whether the install target should be enabled for use in the VDI service.

root vdi installTargets Dataset Installation Target targetName

Dataset Installation Target

Type: enum (of string)

Must be one of:

  • "AmoebaDB"
  • "ClinEpiDB"
  • "CryptoDB"
  • "FungiDB"
  • "GiardiaDB"
  • "HostDB"
  • "MicrobiomeDB"
  • "MicrosporidiaDB"
  • "OrthoMCL"
  • "PiroplasmaDB"
  • "PlasmoDB"
  • "ToxoDB"
  • "TrichDB"
  • "TriTrypDB"
  • "VectorBase"
  • "VEuPathDB"

root vdi installTargets Dataset Installation Target dataTypes

Supported Data Types

Default: ["*"]

Optional list of data types that the install target supports.

Defaults to supporting all data types from any plugins enabled for the install target.

root vdi installTargets Dataset Installation Target controlDb

Dataset Control Database/Schema

Type: object

root vdi installTargets Dataset Installation Target dataDb

Dataset Data Database/Schema

Type: object

root vdi installTargets Dataset Installation Target datasetPropertySchema

Dataset Characteristics Validation Schema


JSON schema used to validate dataset characteristics in the metadata for datasets being installed into this configured target.

If omitted, datasets for this install target are not permitted to have characteristics fields.

root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Inline Schema Definition

Inline Schema Definition

Type: object or boolean

root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Core and Validation specifications meta-schema allOf Core vocabulary meta-schema

Core vocabulary meta-schema

Type: object or boolean
root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Core and Validation specifications meta-schema allOf Applicator vocabulary meta-schema

Applicator vocabulary meta-schema

Type: object or boolean
root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Core and Validation specifications meta-schema allOf Unevaluated applicator vocabulary meta-schema

Unevaluated applicator vocabulary meta-schema

Type: object or boolean
root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Core and Validation specifications meta-schema allOf Validation vocabulary meta-schema

Validation vocabulary meta-schema

Type: object or boolean
root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Core and Validation specifications meta-schema allOf Meta-data vocabulary meta-schema

Meta-data vocabulary meta-schema

Type: object or boolean
root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Core and Validation specifications meta-schema allOf Format vocabulary meta-schema for annotation results

Format vocabulary meta-schema for annotation results

Type: object or boolean
root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Core and Validation specifications meta-schema allOf Content vocabulary meta-schema

Content vocabulary meta-schema

Type: object or boolean

Example:

type: object
properties:
  field:
    type: string
required:
- field

root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Remote Schema File

Remote Schema File

Type: string
Must match regular expression: ^(https?)?://([0-9a-zA-Z][\w-]+(?:\.[0-9a-zA-Z][\w-]*)*)((?:/[\w%.~-]+)+)(\?.+)?$
root vdi installTargets Dataset Installation Target datasetPropertySchema oneOf Local Schema File

Local Schema File

Type: stringFormat: uri-reference

Path to a local schema file. If the path is absolute, and does not exist in the host filesystem, the service jar contents will be checked as well.

Must be at least 6 characters long


Examples:

/etc/vdi/mounted-filesystem-schema.json

/schema/data/jar-resource-schema.json

root definitions

Shared Value Definitions

Type: object

Object that may be used to hold common $defs that may be referenced elsewhere in the config file using YAML anchors and aliases.

root $schema
Type: stringFormat: uri