repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
corda/corda-runtime-os | 89d7558220366c13a65c1d6001a63846dfda2c93 | 2023-03-20T13:01:44 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"additionalProperties": false,
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 04319f9cbf6332b86811ee9f66d116cb1e21073e | 2023-10-10T08:32:07 | libs/configuration/configuration-validation/src/test/resources/schema/valid/test-schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/valid/test-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"anotherTestInteger": {
"maximum": 500,
"minimum": 0,
"type": "integer"
},
"testInteger": {
"default": 7,
"maximum": 500,
"minimum": 0,
"type": "integer"
},
"testObject": {
"additionalProperties": false,
"default": {
"testPropertyA": {
"a": 1
}
},
"dependencies": {
"testPropertyA": {
"not": {
"required": [
"testPropertyB"
]
}
},
"testPropertyB": {
"not": {
"required": [
"testPropertyA"
]
}
}
},
"properties": {
"testPropertyA": {
"additionalProperties": false,
"properties": {
"a": {
"default": 1,
"type": "integer"
}
},
"type": "object"
},
"testPropertyB": {
"additionalProperties": false,
"properties": {
"b": {
"default": 2,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"testReference": {
"$ref": "https://corda.r3.com/schema/valid/test-reference.json",
"default": {}
},
"testString": {
"type": "string"
}
},
"title": "Validation test schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | c5995642dece09ec18608d58b74783b9ef00df13 | 2023-09-01T08:07:41 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 8a2f07a9ea9a1060fd082f25b884eaa024a82ce4 | 2022-02-11T14:46:05 | libs/configuration/configuration-validation/src/test/resources/schema/valid/test-reference.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/valid/test-reference.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"bar": {
"default": false,
"type": "boolean"
},
"foo": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"foo"
],
"title": "Test reference schema object",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 2f7a878f340467bcdfcf6140cf369d504d33098a | 2023-12-20T10:46:21 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManager": {
"additionalProperties": true,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the State Manager database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Prometheus should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
}
},
"required": [
"clusterDbConnectionPool",
"stateManager"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"$ref": "#/$defs/stateManager"
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | f7477c9f03c0476d7b758f73752874254862cac7 | 2024-01-31T16:34:42 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$comment": "TODO-[CORE-19372]: make 'databases' and 'stateManager' required",
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetimeSeconds\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Maximum pool size",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum pool size (defaults to pool's max size value when null)"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Connection pool configuration for JDBC connections",
"type": "object"
},
"databaseEngine": {
"default": "postgresql",
"enum": [
"postgresql"
],
"title": "The Database Engine Type",
"type": "string"
},
"databaseTemplate": {
"additionalProperties": false,
"default": {},
"properties": {
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "The database host"
},
"name": {
"minLength": 1,
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "The database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"name",
"username",
"password"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for State Manager DB"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"stateManagerRuntimeConnectionSettings": {
"additionalProperties": false,
"default": {},
"if": {
"properties": {
"type": {
"const": "Database"
}
}
},
"properties": {
"connectionPool": {},
"password": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
},
"username": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"then": {
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for the State Manager instance"
}
}
},
"title": "Runtime connection settings for a given State Manager instance and Persistent Storage",
"type": "object"
},
"stateTypePersistentStorageMapping": {
"additionalProperties": false,
"default": {},
"properties": {
"partition": {
"default": "default",
"minLength": 1,
"title": "The name of the internal representation (schema, region, partition, namespace, etc.) within the persistent storage that will be used to manage states",
"type": "string"
},
"storageId": {
"default": "default",
"minLength": 1,
"title": "The id of the persistent storage, defined elsewhere, that will be used to manage states",
"type": "string"
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
}
},
"required": [
"type",
"storageId",
"partition"
],
"title": "Association between a State Type managed by the State Manager and a defined Persistent Storage",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"$comment": "TODO-[CORE-19372]: should we replace 'cluster', 'crypto' and 'rbac' by the new 'databases' section instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"databases": {
"items": {
"$ref": "#/$defs/databaseTemplate"
},
"title": "Administrator credentials per database, used to configure users/roles and grant required runtime permissions",
"type": "array"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the entire 'stateManager' section",
"crypto": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowStatus": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"databases": {
"$comment": "At least one database with name 'default' must be defined",
"contains": {
"properties": {
"name": {
"const": "default",
"type": "string"
}
},
"type": "object"
},
"items": {
"allOf": [
{
"$ref": "#/$defs/databaseTemplate"
}
],
"required": [
"host",
"port",
"type"
],
"type": "object"
},
"minItems": 1,
"title": "List of databases used by the platform",
"type": "array"
},
"db": {
"$comment": "TODO-[CORE-19372]: should we replace this by the new 'databases' instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"$ref": "#/$defs/databaseEngine",
"title": "the cluster database type"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Corda should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Corda should keep; if empty, all metrics are kept",
"type": "array"
},
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowCheckpoint' states",
"type": "object"
},
"flowMapping": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowMapping' states",
"type": "object"
},
"flowStatus": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowStatus' states",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'keyRotation' states",
"type": "object"
},
"p2pSession": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'peerToPeerSession' states",
"type": "object"
},
"tokenPoolCache": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'tokenPoolCache' states",
"type": "object"
}
},
"required": [
"flowCheckpoint",
"flowMapping",
"flowStatus",
"keyRotation",
"p2pSession",
"tokenPoolCache"
],
"title": "Persistent Storage configuration for each State Type managed by the State Manager within the Platform",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'keyRotation' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
]
}
},
"required": [
"stateManager",
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'flowCheckpoint' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowCheckpoint"
],
"type": "object"
}
]
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'flowMapping' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"flowMapping": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowMapping"
],
"type": "object"
}
]
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'p2pSession' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"p2pSession": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"p2pSession"
],
"type": "object"
}
]
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'keyRotation' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"flowStatus": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowStatus",
"keyRotation"
],
"type": "object"
}
]
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'tokenPoolCache' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"tokenPoolCache": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"tokenPoolCache"
],
"type": "object"
}
]
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 562ac0ca0c2b612933d8b7d7d86e2522c64e13af | 2023-07-13T15:08:52 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 814a55a943143d28e0e901041f707000d4d89638 | 2023-02-15T17:41:25 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"jdbcUrl": {
"description": "The JDBC database URL",
"type": [
"string",
"null"
]
},
"params": {
"description": "Additional db params the worker is bootstrapped with.",
"type": "object"
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 0b92c0b3aedaeff3efc5a3c0d8f743204fc64a0b | 2022-09-06T09:18:54 | libs/configuration/configuration-validation/src/test/resources/schema/valid/test-schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/valid/test-schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"testInteger": {
"default": 7,
"maximum": 500,
"minimum": 0,
"type": "integer"
},
"testReference": {
"$ref": "https://corda.r3.com/schema/valid/test-reference.json",
"default": {}
},
"testString": {
"type": "string"
}
},
"title": "Validation test schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 01a9b434b69ff38a14c0efcd11a9adac110271d0 | 2023-07-25T12:26:32 | libs/configuration/configuration-validation/src/test/resources/schema/valid/test-schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/valid/test-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"testInteger": {
"default": 7,
"maximum": 500,
"minimum": 0,
"type": "integer"
},
"testObject": {
"additionalProperties": false,
"default": {
"testPropertyA": {
"a": 1
}
},
"dependencies": {
"testPropertyA": {
"not": {
"required": [
"testPropertyB"
]
}
},
"testPropertyB": {
"not": {
"required": [
"testPropertyA"
]
}
}
},
"properties": {
"testPropertyA": {
"additionalProperties": false,
"properties": {
"a": {
"default": 1,
"type": "integer"
}
},
"type": "object"
},
"testPropertyB": {
"additionalProperties": false,
"properties": {
"b": {
"default": 2,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"testReference": {
"$ref": "https://corda.r3.com/schema/valid/test-reference.json",
"default": {}
},
"testString": {
"type": "string"
}
},
"title": "Validation test schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | e011b42ad8f7918ed99dc378ebe8b59ba9a3b182 | 2023-10-23T13:56:18 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManager": {
"additionalProperties": true,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the State Manager database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"default": [],
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 2b824f65ff4200d04c1caf3844946bf464084849 | 2023-10-25T07:21:21 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManager": {
"additionalProperties": true,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the State Manager database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"default": [],
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"$ref": "#/$defs/stateManager"
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | d88b20ad11c4e0a540e84afb673fe5143e887b6c | 2023-10-10T17:09:16 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "STATE_MANAGER",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "STATE_MANAGER",
"examples": [
"STATE_MANAGER"
],
"minLength": 1,
"title": "the schema in which the State Manager entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 9bce8580ef7b34ed97fe874753a5760829e173e2 | 2023-10-10T14:41:18 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"ca": {
"description": "Certification Authority Certificate chain in PEM format",
"properties": {
"crt": {
"properties": {
"path": {
"description": "File path to the Certification Authority Certificate chain in PEM format",
"type": [
"string",
"null"
]
}
}
}
}
},
"crt": {
"description": "Certificate to use in PEM format",
"properties": {
"path": {
"description": "File path to the certificate in PEM format",
"type": [
"string",
"null"
]
}
}
},
"key": {
"description": "Private key to use in PEM format",
"properties": {
"path": {
"description": "File path to the private key in PEM format",
"type": [
"string",
"null"
]
}
}
},
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"stateManager": {
"additionalProperties": true,
"description": "Configuration options for the state manager.",
"properties": {
"database": {
"additionalProperties": false,
"description": "Connection parameters when using database as the persistent storage",
"properties": {
"jdbc": {
"additionalProperties": false,
"description": "The JDBC database info",
"properties": {
"additionalProperties": false,
"directory": {
"description": "The JDBC directory to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
},
"driver": {
"description": "The JDBC driver to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Admin password to use by the state manager when connecting to the database used as the persistent storage",
"type": [
"string",
"null"
]
},
"pool": {
"additionalProperties": false,
"description": "State Manager database pool connection properties",
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"description": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"keepAliveTimeSeconds": {
"default": 0,
"description": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"maxLifetimeSeconds": {
"default": 1800,
"description": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"minimum": 1,
"type": [
"integer",
"null"
]
},
"maxSize": {
"default": 5,
"description": "Maximum connection pool size for State Manager DB",
"type": [
"integer",
"null"
]
},
"minSize": {
"default": 0,
"description": "Minimum connection pool size for State Manager DB",
"type": [
"integer",
"null"
]
},
"validationTimeoutSeconds": {
"default": 5,
"description": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"minimum": 1,
"type": [
"integer",
"null"
]
}
}
},
"user": {
"description": "Admin username to use by the state manager when connecting to the database used as the persistent storage",
"type": [
"string",
"null"
]
}
}
},
"type": {
"description": "The type of state manager.",
"type": [
"string",
"null"
]
}
}
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
},
"worker": {
"additionalProperties": false,
"description": "HTTP connection information for the Corda workers",
"properties": {
"endpoints": {
"additionalProperties": true,
"description": "Internal endpoints for Corda worker load balancers",
"properties": {
"crypto": {
"description": "Endpoint for the CryptoWorker load balancer",
"type": [
"string",
"null"
]
},
"persistence": {
"description": "Endpoint for the PersistenceWorker load balancer",
"type": [
"string",
"null"
]
},
"uniqueness": {
"description": "Endpoint for the UniquenessWorker load balancer",
"type": [
"string",
"null"
]
},
"verification": {
"description": "Endpoint for the VerificationWorker load balancer",
"type": [
"string",
"null"
]
}
}
}
}
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 059336494a9f7efbd0a3893e4fa63d5671ea7b98 | 2022-09-19T08:56:40 | libs/configuration/configuration-validation/src/test/resources/schema/valid/test-schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/valid/test-schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"testInteger": {
"default": 7,
"maximum": 500,
"minimum": 0,
"type": "integer"
},
"testObject": {
"additionalProperties": false,
"default": {
"testPropertyA": {
"a": 1
}
},
"dependencies": {
"testPropertyA": {
"not": {
"required": [
"testPropertyB"
]
}
},
"testPropertyB": {
"not": {
"required": [
"testPropertyA"
]
}
}
},
"properties": {
"testPropertyA": {
"additionalProperties": false,
"properties": {
"a": {
"default": 1,
"type": "integer"
}
},
"type": "object"
},
"testPropertyB": {
"additionalProperties": false,
"properties": {
"b": {
"default": 2,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"testReference": {
"$ref": "https://corda.r3.com/schema/valid/test-reference.json",
"default": {}
},
"testString": {
"type": "string"
}
},
"title": "Validation test schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 824c289437204f32e86ea7a5b606836f34e1bf25 | 2023-06-28T14:10:50 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 9bbbd101c9bcacd12de8400b184bb92ac83e46eb | 2024-02-06T17:31:56 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetimeSeconds\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Maximum pool size",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum pool size (defaults to pool's max size value when null)"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Connection pool configuration for JDBC connections",
"type": "object"
},
"databaseEngine": {
"default": "postgresql",
"enum": [
"postgresql"
],
"title": "The Database Engine Type",
"type": "string"
},
"databaseTemplate": {
"additionalProperties": false,
"default": {},
"properties": {
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "The database host"
},
"id": {
"minLength": 1,
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "The database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"id",
"username",
"password"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"stateManagerRuntimeConnectionSettings": {
"additionalProperties": false,
"default": {},
"if": {
"properties": {
"type": {
"const": "Database"
}
}
},
"properties": {
"connectionPool": {},
"password": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
},
"username": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"then": {
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for the State Manager instance"
}
}
},
"title": "Runtime connection settings for a given State Manager instance and Persistent Storage",
"type": "object"
},
"stateTypePersistentStorageMapping": {
"additionalProperties": false,
"default": {},
"properties": {
"partition": {
"default": "default",
"minLength": 1,
"title": "The name of the internal representation (schema, region, partition, namespace, etc.) within the persistent storage that will be used to manage states",
"type": "string"
},
"storageId": {
"default": "default",
"minLength": 1,
"title": "The id of the persistent storage, defined elsewhere, that will be used to manage states",
"type": "string"
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
}
},
"required": [
"type",
"storageId",
"partition"
],
"title": "Association between a State Type managed by the State Manager and a defined Persistent Storage",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"$comment": "TODO-[CORE-19372]: should we replace 'cluster', 'crypto' and 'rbac' by the new 'databases' section instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"databases": {
"items": {
"$ref": "#/$defs/databaseTemplate"
},
"title": "Administrator credentials per database, used to configure users/roles and grant required runtime permissions",
"type": "array"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"databases": {
"$comment": "At least one 'default' database must be defined",
"contains": {
"properties": {
"id": {
"const": "default",
"type": "string"
}
},
"type": "object"
},
"items": {
"allOf": [
{
"$ref": "#/$defs/databaseTemplate"
}
],
"required": [
"name",
"host",
"port",
"type"
],
"type": "object"
},
"minItems": 1,
"title": "List of databases used by the platform",
"type": "array"
},
"db": {
"$comment": "TODO-[CORE-19372]: should we replace this by the new 'databases' instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"$ref": "#/$defs/databaseEngine",
"title": "the cluster database type"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Corda should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Corda should keep; if empty, all metrics are kept",
"type": "array"
},
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowCheckpoint' states",
"type": "object"
},
"flowMapping": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowMapping' states",
"type": "object"
},
"flowStatus": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowStatus' states",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'keyRotation' states",
"type": "object"
},
"p2pSession": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'peerToPeerSession' states",
"type": "object"
},
"tokenPoolCache": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'tokenPoolCache' states",
"type": "object"
}
},
"required": [
"flowCheckpoint",
"flowMapping",
"flowStatus",
"keyRotation",
"p2pSession",
"tokenPoolCache"
],
"title": "Persistent Storage configuration for each State Type managed by the State Manager within the Platform",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
},
"required": [
"stateManager",
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowCheckpoint"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowMapping": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowMapping"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"p2pSession": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"p2pSession"
],
"type": "object"
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowStatus": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowStatus",
"keyRotation"
],
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"tokenPoolCache": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"tokenPoolCache"
],
"type": "object"
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka",
"databases",
"stateManager"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | a8c33f7b0beddf31eeb6e25da176e7d5fe370d2d | 2023-10-13T08:13:07 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool"
],
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 31c3da22822c244dcec159ebfe58b7168b00f60c | 2022-06-20T08:51:13 | libs/packaging/packaging-verify/src/main/resources/corda-cpk-2.0.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/packaging/cpk/2.0/corda.cpk.dependencies.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Schema for CPK dependencies",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"verifyFileHash"
]
},
{
"required": [
"verifySameSignerAsMe"
]
}
],
"properties": {
"name": {
"description": "CPK name",
"type": "string"
},
"verifyFileHash": {
"description": "File hash of third party CPK",
"properties": {
"algorithm": {
"description": "Hash algorithm name",
"type": "string"
},
"fileHash": {
"description": "Base64 encoded hash",
"type": "string"
}
},
"required": [
"algorithm",
"fileHash"
],
"type": "object"
},
"verifySameSignerAsMe": {
"description": "Used for dependencies built by the same developer",
"enum": [
true
]
},
"version": {
"description": "CPK version",
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"title": "Corda CPK 2.0 Schema",
"type": "array"
} | Apache-2.0 | en |
corda/corda-runtime-os | 69d474e36706439fd9955ed38a032d6a60c23484 | 2024-02-09T12:38:53 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetimeSeconds\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Maximum pool size",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum pool size (defaults to pool's max size value when null)"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Connection pool configuration for JDBC connections",
"type": "object"
},
"databaseEngine": {
"default": "postgresql",
"enum": [
"postgresql"
],
"title": "The Database Engine Type",
"type": "string"
},
"databaseTemplate": {
"additionalProperties": false,
"default": {},
"properties": {
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "The database host"
},
"id": {
"minLength": 1,
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "The database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
}
},
"required": [
"id"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"persistentStorageMapping": {
"default": {},
"properties": {
"partition": {
"default": "default",
"minLength": 1,
"title": "The name of the internal representation (schema, region, partition, namespace, etc.) within the persistent storage",
"type": "string"
},
"storageId": {
"default": "default",
"minLength": 1,
"title": "The id of the persistent storage, defined elsewhere",
"type": "string"
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage",
"type": "string"
}
},
"required": [
"type",
"storageId",
"partition"
],
"title": "Mapping to a defined Persistent Storage",
"type": "object"
},
"persistentStorageRuntimeConnectionSettings": {
"default": {},
"if": {
"properties": {
"type": {
"const": "Database"
}
}
},
"properties": {
"connectionPool": {},
"password": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage",
"type": "string"
},
"username": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"then": {
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for the persistent storage"
}
}
},
"title": "Runtime connection settings for a given Persistent Storage",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"commonPodLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all pods created by bootstrap jobs",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"crypto": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
},
"databases": {
"items": {
"additionalProperties": false,
"default": {},
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"id",
"username",
"password"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"title": "Administrator credentials per database, used to configure users/roles and grant required runtime permissions",
"type": "array"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
},
"virtualNodes": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector",
"commonPodLabels"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"commonPodLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all pods created by deployments",
"type": "object"
},
"config": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
}
}
],
"required": [
"encryption",
"partition",
"storageId",
"type"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"databases": {
"$comment": "At least one 'default' database must be defined",
"contains": {
"properties": {
"id": {
"const": "default",
"type": "string"
}
},
"type": "object"
},
"items": {
"allOf": [
{
"$ref": "#/$defs/databaseTemplate"
}
],
"required": [
"name",
"host",
"port",
"type"
],
"type": "object"
},
"minItems": 1,
"title": "List of databases used by the platform",
"type": "array"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Corda should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Corda should keep; if empty, all metrics are kept",
"type": "array"
},
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowCheckpoint' states",
"type": "object"
},
"flowMapping": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowMapping' states",
"type": "object"
},
"flowStatus": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowStatus' states",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'keyRotation' states",
"type": "object"
},
"p2pSession": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'peerToPeerSession' states",
"type": "object"
},
"tokenPoolCache": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'tokenPoolCache' states",
"type": "object"
}
},
"required": [
"flowCheckpoint",
"flowMapping",
"flowStatus",
"keyRotation",
"p2pSession",
"tokenPoolCache"
],
"title": "Persistent Storage configuration for each State Type managed by the State Manager within the Platform",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
},
"required": [
"stateManager",
"config"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowCheckpoint"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowMapping": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowMapping"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"p2pSession": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"p2pSession"
],
"type": "object"
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"config"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowStatus": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowStatus",
"keyRotation"
],
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"tokenPoolCache": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"tokenPoolCache"
],
"type": "object"
}
},
"required": [
"config"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"config"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"kafka",
"databases",
"stateManager"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | fa2747fa1588a9812a57d86ff919893c32aaa31c | 2023-03-23T08:57:03 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"additionalProperties": false,
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"ca": {
"description": "Certification Authority Certificate chain in PEM format",
"properties": {
"crt": {
"properties": {
"path": {
"description": "File path to the Certification Authority Certificate chain in PEM format",
"type": [
"string",
"null"
]
}
}
}
}
},
"crt": {
"description": "Certificate to use in PEM format",
"properties": {
"path": {
"description": "File path to the certificate in PEM format",
"type": [
"string",
"null"
]
}
}
},
"key": {
"description": "Private key to use in PEM format",
"properties": {
"path": {
"description": "File path to the private key in PEM format",
"type": [
"string",
"null"
]
}
}
},
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 6716561952d43a642bd036a8ed7c87056230f651 | 2023-10-11T18:30:34 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool"
],
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 887b4d22a312fc95511d3908e3476812f0e3936a | 2023-03-01T16:25:44 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"params": {
"description": "Additional db params the worker is bootstrapped with.",
"properties": {
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 8dc0b87ac97b64c1f344db17fa22427931d5e8d3 | 2024-05-07T10:09:53 | libs/ledger/ledger-common-data/src/main/resources/schema/v1/transaction-metadata.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.net/schema/transaction-metadata.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"allOf": [
{
"$ref": "#/definitions/if-consensual-ledger"
},
{
"$ref": "#/definitions/if-utxo-ledger"
}
],
"definitions": {
"if-consensual-ledger": {
"if": {
"properties": {
"ledgerModel": {
"const": "net.corda.ledger.consensual.data.transaction.ConsensualLedgerTransactionImpl"
}
}
},
"then": {
"properties": {
"membershipGroupParametersHash": {
"title": "Membership group parameter's hash",
"type": "null"
},
"transactionSubtype": {
"enum": [
null
],
"title": "Transaction subtype",
"type": "null"
}
}
}
},
"if-utxo-ledger": {
"if": {
"properties": {
"ledgerModel": {
"const": "net.corda.ledger.utxo.data.transaction.UtxoLedgerTransactionImpl"
}
}
},
"then": {
"properties": {
"membershipGroupParametersHash": {
"title": "Membership group parameter's hash",
"type": "string"
},
"transactionSubtype": {
"enum": [
"NOTARY_CHANGE",
"GENERAL"
],
"title": "Transaction subtype",
"type": "string"
}
},
"required": [
"transactionSubtype",
"membershipGroupParametersHash"
]
}
},
"package_metadata": {
"additionalProperties": false,
"properties": {
"fileChecksum": {
"default": "",
"examples": [
"0000111122223333444455556666777788889999AAAABBBBCCCCDDDDEEEEFFFF"
],
"pattern": "^.*$",
"title": "File checksum",
"type": "string"
},
"name": {
"default": "",
"examples": [
"TestPackage"
],
"pattern": "^.*$",
"title": "Name",
"type": "string"
},
"signerSummaryHash": {
"default": "",
"examples": [
"46616B652D76616C7565"
],
"pattern": "^.*$",
"title": "Signer summary hash",
"type": "string"
},
"version": {
"default": "",
"examples": [
"0.0.1-test"
],
"pattern": "^.*$",
"title": "Version",
"type": "string"
}
},
"required": [
"name",
"version",
"signerSummaryHash",
"fileChecksum"
],
"type": "object"
}
},
"properties": {
"componentGroups": {
"default": [],
"description": "Java types or simple string representation of components without duplications",
"examples": [
[
[
"metadata"
],
[
"net.corda.v5.base.types.MemberX500Name",
"java.security.PublicKey",
"net.corda.v5.ledger.utxo.TimeWindow"
],
[
"java.security.PublicKey"
],
[
"net.corda.ledger.utxo.data.transaction.UtxoOutputInfoComponent"
],
[
"CommandInfo"
],
[
"net.corda.v5.crypto.SecureHash"
],
[
"net.corda.v5.ledger.utxo.StateRef"
],
[
"net.corda.v5.ledger.utxo.StateRef"
],
[
"net.corda.v5.ledger.utxo.ContractState"
],
[
"net.corda.v5.ledger.utxo.Command"
]
]
],
"items": {
"items": {
"default": "",
"title": "Component",
"type": "string"
},
"title": "Component group",
"type": "array"
},
"title": "Component group structure",
"type": "array"
},
"cpiMetadata": {
"$ref": "#/definitions/package_metadata",
"title": "CPI metadata"
},
"cpkMetadata": {
"default": [],
"items": {
"$ref": "#/definitions/package_metadata",
"title": "Items"
},
"minItems": 1,
"title": "CPK metadata",
"type": "array"
},
"digestSettings": {
"description": "Settings relating to the Merkle tree digest algorithms.",
"properties": {
"batchMerkleTreeDigestAlgorithmName": {
"default": "",
"description": "Algorithm name of the digest provider for the batch Merkle tree.",
"examples": [
"SHA-256D"
],
"pattern": "^.*$",
"title": "Batch Merkle tree digest algorithm name",
"type": "string"
},
"batchMerkleTreeDigestOptionsLeafPrefixB64": {
"default": "",
"examples": [
"bGVhZg=="
],
"pattern": "^.*$",
"title": "Batch Merkle tree digest options leaf prefix base64 encoded",
"type": "string"
},
"batchMerkleTreeDigestOptionsNodePrefixB64": {
"default": "",
"examples": [
"bm9kZQ=="
],
"pattern": "^.*$",
"title": "Batch Merkle tree digest options node prefix base64 encoded",
"type": "string"
},
"batchMerkleTreeDigestProviderName": {
"default": "",
"description": "Class name of the digest provider for the batch Merkle tree.",
"examples": [
"TweakableHashDigestProvider"
],
"pattern": "^.*$",
"title": "Batch Merkle tree digest provider name",
"type": "string"
},
"componentMerkleTreeDigestAlgorithmName": {
"default": "",
"examples": [
"SHA-256D"
],
"pattern": "^.*$",
"title": "Component Merkle tree digest algorithm name",
"type": "string"
},
"componentMerkleTreeDigestProviderName": {
"default": "",
"examples": [
"NonceHashDigestProvider"
],
"pattern": "^.*$",
"title": "Component Merkle tree digest provider name",
"type": "string"
},
"componentMerkleTreeEntropyAlgorithmName": {
"default": "",
"examples": [
"SHA-256D"
],
"pattern": "^.*$",
"title": "Component Merkle tree entropy algorithm name",
"type": "string"
},
"rootMerkleTreeDigestAlgorithmName": {
"default": "",
"description": "Algorithm name of the digest provider for the root Merkle tree.",
"examples": [
"SHA-256D"
],
"pattern": "^.*$",
"title": "Root Merkle tree digest algorithm name",
"type": "string"
},
"rootMerkleTreeDigestOptionsLeafPrefixB64": {
"default": "",
"examples": [
"bGVhZg=="
],
"pattern": "^.*$",
"title": "Root Merkle tree digest options leaf prefix base64 encoded",
"type": "string"
},
"rootMerkleTreeDigestOptionsNodePrefixB64": {
"default": "",
"examples": [
"bm9kZQ=="
],
"pattern": "^.*$",
"title": "Root Merkle tree digest options node prefix base64 encoded",
"type": "string"
},
"rootMerkleTreeDigestProviderName": {
"default": "",
"description": "Class name of the digest provider for the root Merkle tree.",
"examples": [
"TweakableHashDigestProvider"
],
"pattern": "^.*$",
"title": "Root Merkle tree digest provider name",
"type": "string"
}
},
"required": [
"batchMerkleTreeDigestProviderName",
"batchMerkleTreeDigestAlgorithmName",
"batchMerkleTreeDigestOptionsLeafPrefixB64",
"batchMerkleTreeDigestOptionsNodePrefixB64",
"rootMerkleTreeDigestProviderName",
"rootMerkleTreeDigestAlgorithmName",
"rootMerkleTreeDigestOptionsLeafPrefixB64",
"rootMerkleTreeDigestOptionsNodePrefixB64",
"componentMerkleTreeDigestProviderName",
"componentMerkleTreeDigestAlgorithmName",
"componentMerkleTreeEntropyAlgorithmName"
],
"title": "Digest settings",
"type": "object",
"unevaluatedProperties": false
},
"ledgerModel": {
"description": "The name of the class that implements this type of ledger transaction.",
"enum": [
"net.corda.ledger.utxo.data.transaction.UtxoLedgerTransactionImpl",
"net.corda.ledger.consensual.data.transaction.ConsensualLedgerTransactionImpl"
],
"title": "Ledger model",
"type": "string"
},
"ledgerVersion": {
"default": "",
"examples": [
1
],
"title": "Ledger version",
"type": "integer"
},
"membershipGroupParametersHash": {
"default": "",
"examples": [
"SHA-256:98AF8725385586B41FEFF205B4E05A000823F78B5F8F5C02439CE8F67A781D90"
],
"pattern": "^.*$",
"title": "Membership group parameter's hash",
"type": [
"string",
"null"
]
},
"platformVersion": {
"default": "",
"examples": [
1
],
"title": "Active platform version at the time of the creation of the transaction",
"type": "integer"
},
"schemaVersion": {
"default": "",
"examples": [
1
],
"title": "Metadata schema version",
"type": "integer"
},
"transactionSubtype": {
"enum": [
null,
"NOTARY_CHANGE",
"GENERAL"
],
"title": "Transaction subtype",
"type": [
"string",
"null"
]
}
},
"required": [
"cpiMetadata",
"cpkMetadata",
"digestSettings",
"ledgerModel",
"ledgerVersion",
"componentGroups",
"platformVersion",
"schemaVersion"
],
"title": "Root",
"type": "object",
"unevaluatedProperties": false
} | Apache-2.0 | en |
corda/corda-runtime-os | 37b128a38384a8f6323a7091df1b1bd15e1fe80f | 2024-02-09T13:28:56 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetimeSeconds\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Maximum pool size",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum pool size (defaults to pool's max size value when null)"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Connection pool configuration for JDBC connections",
"type": "object"
},
"databaseEngine": {
"default": "postgresql",
"enum": [
"postgresql"
],
"title": "The Database Engine Type",
"type": "string"
},
"databaseTemplate": {
"additionalProperties": false,
"default": {},
"properties": {
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "The database host"
},
"id": {
"minLength": 1,
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "The database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
}
},
"required": [
"id"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"persistentStorageMapping": {
"default": {},
"properties": {
"partition": {
"default": "default",
"minLength": 1,
"title": "The name of the internal representation (schema, region, partition, namespace, etc.) within the persistent storage",
"type": "string"
},
"storageId": {
"default": "default",
"minLength": 1,
"title": "The id of the persistent storage, defined elsewhere",
"type": "string"
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage",
"type": "string"
}
},
"required": [
"type",
"storageId",
"partition"
],
"title": "Mapping to a defined Persistent Storage",
"type": "object"
},
"persistentStorageRuntimeConnectionSettings": {
"default": {},
"if": {
"properties": {
"type": {
"const": "Database"
}
}
},
"properties": {
"connectionPool": {},
"password": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage",
"type": "string"
},
"username": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"then": {
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for the persistent storage"
}
}
},
"title": "Runtime connection settings for a given Persistent Storage",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"commonPodLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all pods created by bootstrap jobs",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"crypto": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
},
"databases": {
"items": {
"additionalProperties": false,
"default": {},
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"id",
"username",
"password"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"title": "Administrator credentials per database, used to configure users/roles and grant required runtime permissions",
"type": "array"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
},
"virtualNodes": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector",
"commonPodLabels"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"commonPodLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all pods created by deployments",
"type": "object"
},
"config": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
}
}
],
"required": [
"encryption",
"partition",
"storageId",
"type"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"databases": {
"$comment": "At least one 'default' database must be defined",
"contains": {
"properties": {
"id": {
"const": "default",
"type": "string"
}
},
"type": "object"
},
"items": {
"allOf": [
{
"$ref": "#/$defs/databaseTemplate"
}
],
"required": [
"name",
"host",
"port",
"type"
],
"type": "object"
},
"minItems": 1,
"title": "List of databases used by the platform",
"type": "array"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Corda should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Corda should keep; if empty, all metrics are kept",
"type": "array"
},
"podMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowCheckpoint' states",
"type": "object"
},
"flowMapping": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowMapping' states",
"type": "object"
},
"flowStatus": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowStatus' states",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'keyRotation' states",
"type": "object"
},
"p2pSession": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'peerToPeerSession' states",
"type": "object"
},
"tokenPoolCache": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'tokenPoolCache' states",
"type": "object"
}
},
"required": [
"flowCheckpoint",
"flowMapping",
"flowStatus",
"keyRotation",
"p2pSession",
"tokenPoolCache"
],
"title": "Persistent Storage configuration for each State Type managed by the State Manager within the Platform",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
},
"required": [
"stateManager",
"config"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowCheckpoint"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowMapping": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowMapping"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"p2pSession": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"p2pSession"
],
"type": "object"
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"config"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowStatus": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowStatus",
"keyRotation"
],
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"tokenPoolCache": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"tokenPoolCache"
],
"type": "object"
}
},
"required": [
"config"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"config"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"kafka",
"databases",
"stateManager"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 8a2f07a9ea9a1060fd082f25b884eaa024a82ce4 | 2022-02-11T14:46:05 | libs/configuration/configuration-validation/src/test/resources/schema/valid/test-schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/valid/test-schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"testInteger": {
"default": 7,
"maximum": 500,
"minimum": 0,
"type": "integer"
},
"testReference": {
"$ref": "https://corda.r3.com/schema/valid/test-reference.json"
},
"testString": {
"type": "string"
}
},
"title": "Validation test schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 0738265527081ae3bc0face929979691397029c9 | 2024-01-26T09:28:09 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$comment": "TODO-[CORE-19372]: make 'databases' and 'stateManager' required",
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetimeSeconds\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Maximum pool size",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum pool size (defaults to pool's max size value when null)"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Connection pool configuration for JDBC connections",
"type": "object"
},
"databaseEngine": {
"default": "postgresql",
"enum": [
"postgresql"
],
"title": "The Database Engine Type",
"type": "string"
},
"databaseTemplate": {
"additionalProperties": false,
"default": {},
"properties": {
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "The database host"
},
"name": {
"minLength": 1,
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "The database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"name",
"username",
"password"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for State Manager DB"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"stateManagerRuntimeConnectionSettings": {
"additionalProperties": false,
"default": {},
"if": {
"properties": {
"type": {
"const": "Database"
}
}
},
"properties": {
"connectionPool": {},
"password": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
},
"username": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"then": {
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for the State Manager instance"
}
}
},
"title": "Runtime connection settings for a given State Manager instance and Persistent Storage",
"type": "object"
},
"stateTypePersistentStorageMapping": {
"additionalProperties": false,
"default": {},
"properties": {
"partition": {
"default": "default",
"minLength": 1,
"title": "The name of the internal representation (schema, region, partition, namespace, etc.) within the persistent storage that will be used to manage states",
"type": "string"
},
"storageId": {
"default": "default",
"minLength": 1,
"title": "The id of the persistent storage, defined elsewhere, that will be used to manage states",
"type": "string"
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
}
},
"required": [
"type",
"storageId",
"partition"
],
"title": "Association between a State Type managed by the State Manager and a defined Persistent Storage",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"$comment": "TODO-[CORE-19372]: should we replace 'cluster', 'crypto' and 'rbac' by the new 'databases' section instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"databases": {
"items": {
"$ref": "#/$defs/databaseTemplate"
},
"title": "Administrator credentials per database, used to configure users/roles and grant required runtime permissions",
"type": "array"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the entire 'stateManager' section",
"crypto": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowStatus": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"databases": {
"$comment": "At least one database with name 'default' must be defined",
"contains": {
"properties": {
"name": {
"const": "default",
"type": "string"
}
},
"type": "object"
},
"items": {
"allOf": [
{
"$ref": "#/$defs/databaseTemplate"
}
],
"required": [
"host",
"port",
"type"
],
"type": "object"
},
"minItems": 1,
"title": "List of databases used by the platform",
"type": "array"
},
"db": {
"$comment": "TODO-[CORE-19372]: should we replace this by the new 'databases' instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"$ref": "#/$defs/databaseEngine",
"title": "the cluster database type"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Prometheus should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowCheckpoint' states",
"type": "object"
},
"flowMapping": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowMapping' states",
"type": "object"
},
"flowStatus": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowStatus' states",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'keyRotation' states",
"type": "object"
},
"p2pSession": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'peerToPeerSession' states",
"type": "object"
},
"tokenPoolCache": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'tokenPoolCache' states",
"type": "object"
}
},
"required": [
"flowCheckpoint",
"flowMapping",
"flowStatus",
"keyRotation",
"p2pSession",
"tokenPoolCache"
],
"title": "Persistent Storage configuration for each State Type managed by the State Manager within the Platform",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'keyRotation' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
]
}
},
"required": [
"stateManager",
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'flowCheckpoint' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowCheckpoint"
],
"type": "object"
}
]
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'flowMapping' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"flowMapping": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowMapping"
],
"type": "object"
}
]
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'p2pSession' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"p2pSession": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"p2pSession"
],
"type": "object"
}
]
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'keyRotation' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"flowStatus": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowStatus",
"keyRotation"
],
"type": "object"
}
]
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'tokenPoolCache' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"tokenPoolCache": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"tokenPoolCache"
],
"type": "object"
}
]
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 0d9829e23e6f55f5de1870280433d6b8d1a994a6 | 2023-08-29T09:24:15 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 01a9b434b69ff38a14c0efcd11a9adac110271d0 | 2023-07-25T12:26:32 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"additionalProperties": false,
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"ca": {
"description": "Certification Authority Certificate chain in PEM format",
"properties": {
"crt": {
"properties": {
"path": {
"description": "File path to the Certification Authority Certificate chain in PEM format",
"type": [
"string",
"null"
]
}
}
}
}
},
"crt": {
"description": "Certificate to use in PEM format",
"properties": {
"path": {
"description": "File path to the certificate in PEM format",
"type": [
"string",
"null"
]
}
}
},
"key": {
"description": "Private key to use in PEM format",
"properties": {
"path": {
"description": "File path to the private key in PEM format",
"type": [
"string",
"null"
]
}
}
},
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | ecf54df67e229b1c1dd3c97c1c8eb8f9c219d7b0 | 2023-12-12T13:16:05 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManager": {
"additionalProperties": true,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the State Manager database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Prometheus should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
}
},
"required": [
"clusterDbConnectionPool",
"stateManager"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"$ref": "#/$defs/stateManager"
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | dcef443e10a537ed748556503cbfd0e939527b72 | 2024-01-29T14:45:35 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"ca": {
"description": "Certification Authority Certificate chain in PEM format",
"properties": {
"crt": {
"properties": {
"path": {
"description": "File path to the Certification Authority Certificate chain in PEM format",
"type": [
"string",
"null"
]
}
}
}
}
},
"crt": {
"description": "Certificate to use in PEM format",
"properties": {
"path": {
"description": "File path to the certificate in PEM format",
"type": [
"string",
"null"
]
}
}
},
"key": {
"description": "Private key to use in PEM format",
"properties": {
"path": {
"description": "File path to the private key in PEM format",
"type": [
"string",
"null"
]
}
}
},
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"stateManager": {
"$ref": "https://corda.r3.com/net/corda/schema/configuration/stateManager/1.0/corda.stateManager.json",
"description": "State Manager configuration."
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
},
"worker": {
"additionalProperties": false,
"description": "HTTP connection information for the Corda workers",
"properties": {
"endpoints": {
"additionalProperties": true,
"description": "Internal endpoints for Corda worker load balancers",
"properties": {
"crypto": {
"description": "Endpoint for the CryptoWorker load balancer",
"type": [
"string",
"null"
]
},
"persistence": {
"description": "Endpoint for the PersistenceWorker load balancer",
"type": [
"string",
"null"
]
},
"uniqueness": {
"description": "Endpoint for the UniquenessWorker load balancer",
"type": [
"string",
"null"
]
},
"verification": {
"description": "Endpoint for the VerificationWorker load balancer",
"type": [
"string",
"null"
]
}
}
}
}
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | b48fc3cae312cf4af90da8c9c585988a2b851db2 | 2023-10-25T08:50:31 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManager": {
"additionalProperties": true,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the State Manager database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Prometheus should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"$ref": "#/$defs/stateManager"
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | ef6bcc266e3e0fa23742306aee33d95134cc231e | 2022-06-21T13:52:56 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"jdbcUrl": {
"description": "The JDBC database URL",
"type": [
"string",
"null"
]
},
"params": {
"description": "Additional db params the worker is bootstrapped with.",
"type": "object"
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 8a2f07a9ea9a1060fd082f25b884eaa024a82ce4 | 2022-02-11T14:46:05 | libs/configuration/configuration-validation/src/test/resources/schema/bad-reference/bad-reference.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/bad-reference/bad-reference.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"testInteger": {
"default": 7,
"maximum": 500,
"minimum": 0,
"type": "integer"
},
"testReference": {
"$ref": "https://corda.r3.com/schema/bad-reference/test-reference.json"
},
"testString": {
"type": "string"
}
},
"title": "Validation test schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 2853816454400aba9a55db1e07e6f869c90211d7 | 2023-10-05T16:34:14 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "STATE_MANAGER",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "STATE_MANAGER",
"examples": [
"STATE_MANAGER"
],
"minLength": 1,
"title": "the schema in which the State Manager entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Flow worker JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Flow worker minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Flow worker JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 01a9b434b69ff38a14c0efcd11a9adac110271d0 | 2023-07-25T12:26:32 | libs/configuration/configuration-validation/src/test/resources/schema/valid/test-reference.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/valid/test-reference.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"properties": {
"bar": {
"default": false,
"type": "boolean"
},
"foo": {
"default": [
1,
2,
3
],
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"foo"
],
"title": "Test reference schema object",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | afab21763ad4fbd094d38bc541966053f0c6d512 | 2023-10-13T14:09:42 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": true,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the State Manager database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 438bf3771a593c56f4f2583572c9b3063f784af4 | 2023-10-13T17:39:21 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"default": [],
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": true,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the State Manager database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"$ref": "#/$defs/stateManagerDbConnectionPool"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 2953dc7a20da996521ed515342f4b2966ae9c622 | 2023-09-21T13:30:52 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"ca": {
"description": "Certification Authority Certificate chain in PEM format",
"properties": {
"crt": {
"properties": {
"path": {
"description": "File path to the Certification Authority Certificate chain in PEM format",
"type": [
"string",
"null"
]
}
}
}
}
},
"crt": {
"description": "Certificate to use in PEM format",
"properties": {
"path": {
"description": "File path to the certificate in PEM format",
"type": [
"string",
"null"
]
}
}
},
"key": {
"description": "Private key to use in PEM format",
"properties": {
"path": {
"description": "File path to the private key in PEM format",
"type": [
"string",
"null"
]
}
}
},
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"stateManager": {
"additionalProperties": true,
"description": "Configuration options for the state manager.",
"properties": {
"database": {
"additionalProperties": false,
"description": "Connection parameters when using database as the persistent storage",
"properties": {
"jdbc": {
"additionalProperties": false,
"description": "The JDBC database info",
"properties": {
"additionalProperties": false,
"directory": {
"description": "The JDBC directory to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
},
"driver": {
"description": "The JDBC driver to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
},
"persistenceUnitName": {
"description": "The persistence unit name to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Admin password to use by the state manager when connecting to the database used as the persistent storage",
"type": [
"string",
"null"
]
},
"pool": {
"additionalProperties": false,
"description": "State Manager database pool connection properties",
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"description": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"keepAliveTimeSeconds": {
"default": 0,
"description": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"maxLifetimeSeconds": {
"default": 1800,
"description": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"minimum": 1,
"type": [
"integer",
"null"
]
},
"maxSize": {
"default": 5,
"description": "Maximum connection pool size for State Manager DB",
"type": [
"integer",
"null"
]
},
"minSize": {
"default": 0,
"description": "Minimum connection pool size for State Manager DB",
"type": [
"integer",
"null"
]
},
"validationTimeoutSeconds": {
"default": 5,
"description": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"minimum": 1,
"type": [
"integer",
"null"
]
}
}
},
"user": {
"description": "Admin username to use by the state manager when connecting to the database used as the persistent storage",
"type": [
"string",
"null"
]
}
}
},
"type": {
"description": "The type of state manager.",
"type": [
"string",
"null"
]
}
}
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | d1d0fe1096199a0bf1a7ac6b53afd486dd2db1b6 | 2023-03-17T17:10:09 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"additionalProperties": false,
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"params": {
"description": "Additional db params the worker is bootstrapped with.",
"properties": {
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"params": {
"description": "Additional params REST worker is bootstrapped with.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
}
}
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
ng-docs/angular-cn | 6ed156439558e72d41db14899ae33cb52c833f18 | 2019-03-06T00:48:26 | packages/service-worker/config/schema.json | 40 | 2024-05-27T05:00:32.608991Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"appData": {
"description": "This section enables you to pass any data you want that describes this particular version of the app. The SwUpdate service includes that data in the update notifications. Many apps use this section to provide additional information for the display of UI popups, notifying users of the available update.",
"type": "object"
},
"assetGroups": {
"description": "Assets are resources that are part of the app version that update along with the app. They can include resources loaded from the page's origin as well as third-party resources loaded from CDNs and other external URLs. As not all such external URLs may be known at build time, URL patterns can be matched.",
"items": {
"additionalProperties": false,
"properties": {
"installMode": {
"default": "prefetch",
"description": "Determines how the resources are initially cached. 'prefetch' tells the Angular service worker to fetch every single listed resource while it's caching the current version of the app. This is bandwidth-intensive but ensures resources are available whenever they're requested, even if the browser is currently offline. 'lazy' does not cache any of the resources up front. Instead, the Angular service worker only caches resources for which it receives requests. This is an on-demand caching mode. Resources that are never requested will not be cached. This is useful for things like images at different resolutions, so the service worker only caches the correct assets for the particular screen and orientation.",
"enum": [
"prefetch",
"lazy"
]
},
"name": {
"description": "It identifies this particular group of assets between versions of the configuration.",
"type": "string"
},
"resources": {
"additionalProperties": false,
"description": "This section describes the resources to cache.",
"properties": {
"files": {
"description": "Lists patterns that match files in the distribution directory. These can be single files or glob-like patterns that match a number of files.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"urls": {
"description": "Includes both URLs and URL patterns that will be matched at runtime. These resources are not fetched directly and do not have content hashes, but they will be cached according to their HTTP headers. This is most useful for CDNs such as the Google Fonts service. (Negative glob patterns are not supported and '?' will be matched literally; i.e. it will not match any character other than '?'.)",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"updateMode": {
"description": "For resources already in the cache, determines the caching behavior when a new version of the app is discovered. Any resources in the group that have changed since the previous version are updated in accordance with 'updateMode'. 'prefetch' tells the service worker to download and cache the changed resources immediately. 'lazy' tells the service worker to not cache those resources. Instead, it treats them as unrequested and waits until they're requested again before updating them. An 'updateMode' of lazy is only valid if the 'installMode' is also lazy. Defaults to the value `installMode` is set to.",
"enum": [
"prefetch",
"lazy"
]
}
},
"required": [
"name",
"resources"
],
"type": "object"
},
"type": "array"
},
"dataGroups": {
"description": "Policies for caching data requests, such as API requests and other data dependencies. Unlike asset resources, data requests are not versioned along with the app.",
"items": {
"additionalProperties": false,
"properties": {
"cacheConfig": {
"additionalProperties": false,
"description": "This section defines the policy by which matching requests will be cached.",
"properties": {
"maxAge": {
"description": "Indicates how long responses are allowed to remain in the cache before being considered invalid and evicted. 'maxAge' is a duration string, using the following unit suffixes: d= days, h= hours, m= minutes, s= seconds, u= milliseconds. For example, the string '3d12h' will cache content for up to three and a half days.",
"type": "string"
},
"maxSize": {
"description": "The maximum number of entries, or responses, in the cache. Open-ended caches can grow in unbounded ways and eventually exceed storage quotas, calling for eviction.",
"type": "integer"
},
"strategy": {
"default": "performance",
"description": "The Angular service worker can use either of two caching strategies for data resources. 'performance', the default, optimizes for responses that are as fast as possible. If a resource exists in the cache, the cached version is used. This allows for some staleness, depending on the 'maxAge', in exchange for better performance. This is suitable for resources that don't change often; for example, user avatar images. 'freshness' optimizes for currency of data, preferentially fetching requested data from the network. Only if the network times out, according to 'timeout', does the request fall back to the cache. This is useful for resources that change frequently; for example, account balances.",
"enum": [
"freshness",
"performance"
]
},
"timeout": {
"description": "This duration string specifies the network timeout. The network timeout is how long the Angular service worker will wait for the network to respond before using a cached response, if configured to do so. 'timeout' is a duration string, using the following unit suffixes: d= days, h= hours, m= minutes, s= seconds, u= milliseconds. For example, the string '5s30u' will translate to five seconds and 30 milliseconds of network timeout.",
"type": "string"
}
},
"required": [
"maxSize",
"maxAge"
],
"type": "object"
},
"name": {
"description": "It identifies this particular group of data between versions of the configuration.",
"type": "string"
},
"urls": {
"description": "A list of URL patterns. URLs that match these patterns will be cached according to this data group's policy. (Negative glob patterns are not supported and '?' will be matched literally; i.e. it will not match any character other than '?'.)",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"version": {
"default": 1,
"description": "Occasionally APIs change formats in a way that is not backward-compatible. A new version of the app may not be compatible with the old API format and thus may not be compatible with existing cached resources from that API. 'version' provides a mechanism to indicate that the resources being cached have been updated in a backwards-incompatible way, and that the old cache entries\u2014those from previous versions\u2014should be discarded.",
"type": "integer"
}
},
"required": [
"name",
"urls",
"cacheConfig"
],
"type": "object"
},
"type": "array"
},
"index": {
"description": "Specifies the file that serves as the index page to satisfy navigation requests. Usually this is '/index.html'.",
"type": "string"
},
"navigationUrls": {
"description": "This optional section enables you to specify a custom list of URLs or URL patterns that will be redirected to the 'index' file.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"index"
],
"type": "object"
} | MIT | en |
ng-docs/angular-cn | 9cfb664109795b1bdcac4999d0e532f6f673b998 | 2020-09-22T16:29:20 | packages/service-worker/config/schema.json | 40 | 2024-05-27T05:00:32.608991Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"appData": {
"description": "This section enables you to pass any data you want that describes this particular version of the app. The SwUpdate service includes that data in the update notifications. Many apps use this section to provide additional information for the display of UI popups, notifying users of the available update.",
"type": "object"
},
"assetGroups": {
"description": "Assets are resources that are part of the app version that update along with the app. They can include resources loaded from the page's origin as well as third-party resources loaded from CDNs and other external URLs. As not all such external URLs may be known at build time, URL patterns can be matched.",
"items": {
"additionalProperties": false,
"properties": {
"cacheQueryOptions": {
"additionalProperties": false,
"description": "Provide options that are passed to Cache#match.",
"properties": {
"ignoreSearch": {
"description": "Whether to ignore the query string in the URL.",
"type": "boolean"
}
},
"type": "object"
},
"installMode": {
"default": "prefetch",
"description": "Determines how the resources are initially cached. 'prefetch' tells the Angular service worker to fetch every single listed resource while it's caching the current version of the app. This is bandwidth-intensive but ensures resources are available whenever they're requested, even if the browser is currently offline. 'lazy' does not cache any of the resources up front. Instead, the Angular service worker only caches resources for which it receives requests. This is an on-demand caching mode. Resources that are never requested will not be cached. This is useful for things like images at different resolutions, so the service worker only caches the correct assets for the particular screen and orientation.",
"enum": [
"prefetch",
"lazy"
]
},
"name": {
"description": "It identifies this particular group of assets between versions of the configuration.",
"type": "string"
},
"resources": {
"additionalProperties": false,
"description": "This section describes the resources to cache.",
"properties": {
"files": {
"description": "Lists patterns that match files in the distribution directory. These can be single files or glob-like patterns that match a number of files.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"urls": {
"description": "Includes both URLs and URL patterns that will be matched at runtime. These resources are not fetched directly and do not have content hashes, but they will be cached according to their HTTP headers. This is most useful for CDNs such as the Google Fonts service. (Negative glob patterns are not supported and '?' will be matched literally; i.e. it will not match any character other than '?'.)",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"updateMode": {
"description": "For resources already in the cache, determines the caching behavior when a new version of the app is discovered. Any resources in the group that have changed since the previous version are updated in accordance with 'updateMode'. 'prefetch' tells the service worker to download and cache the changed resources immediately. 'lazy' tells the service worker to not cache those resources. Instead, it treats them as unrequested and waits until they're requested again before updating them. An 'updateMode' of lazy is only valid if the 'installMode' is also lazy. Defaults to the value `installMode` is set to.",
"enum": [
"prefetch",
"lazy"
]
}
},
"required": [
"name",
"resources"
],
"type": "object"
},
"type": "array"
},
"dataGroups": {
"description": "Policies for caching data requests, such as API requests and other data dependencies. Unlike asset resources, data requests are not versioned along with the app.",
"items": {
"additionalProperties": false,
"properties": {
"cacheConfig": {
"additionalProperties": false,
"description": "This section defines the policy by which matching requests will be cached.",
"properties": {
"maxAge": {
"description": "Indicates how long responses are allowed to remain in the cache before being considered invalid and evicted. 'maxAge' is a duration string, using the following unit suffixes: d= days, h= hours, m= minutes, s= seconds, u= milliseconds. For example, the string '3d12h' will cache content for up to three and a half days.",
"type": "string"
},
"maxSize": {
"description": "The maximum number of entries, or responses, in the cache. Open-ended caches can grow in unbounded ways and eventually exceed storage quotas, calling for eviction.",
"type": "integer"
},
"strategy": {
"default": "performance",
"description": "The Angular service worker can use either of two caching strategies for data resources. 'performance', the default, optimizes for responses that are as fast as possible. If a resource exists in the cache, the cached version is used. This allows for some staleness, depending on the 'maxAge', in exchange for better performance. This is suitable for resources that don't change often; for example, user avatar images. 'freshness' optimizes for currency of data, preferentially fetching requested data from the network. Only if the network times out, according to 'timeout', does the request fall back to the cache. This is useful for resources that change frequently; for example, account balances.",
"enum": [
"freshness",
"performance"
]
},
"timeout": {
"description": "This duration string specifies the network timeout. The network timeout is how long the Angular service worker will wait for the network to respond before using a cached response, if configured to do so. 'timeout' is a duration string, using the following unit suffixes: d= days, h= hours, m= minutes, s= seconds, u= milliseconds. For example, the string '5s30u' will translate to five seconds and 30 milliseconds of network timeout.",
"type": "string"
}
},
"required": [
"maxSize",
"maxAge"
],
"type": "object"
},
"cacheQueryOptions": {
"additionalProperties": false,
"description": "Provide options that are passed to Cache#match.",
"properties": {
"ignoreSearch": {
"description": "Whether to ignore the query string in the URL.",
"type": "boolean"
}
},
"type": "object"
},
"name": {
"description": "It identifies this particular group of data between versions of the configuration.",
"type": "string"
},
"urls": {
"description": "A list of URL patterns. URLs that match these patterns will be cached according to this data group's policy. (Negative glob patterns are not supported and '?' will be matched literally; i.e. it will not match any character other than '?'.)",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"version": {
"default": 1,
"description": "Occasionally APIs change formats in a way that is not backward-compatible. A new version of the app may not be compatible with the old API format and thus may not be compatible with existing cached resources from that API. 'version' provides a mechanism to indicate that the resources being cached have been updated in a backwards-incompatible way, and that the old cache entries\u2014those from previous versions\u2014should be discarded.",
"type": "integer"
}
},
"required": [
"name",
"urls",
"cacheConfig"
],
"type": "object"
},
"type": "array"
},
"index": {
"description": "Specifies the file that serves as the index page to satisfy navigation requests. Usually this is '/index.html'.",
"type": "string"
},
"navigationRequestStrategy": {
"default": "performance",
"description": "The Angular service worker can use two request strategies for navigation requests. 'performance', the default, skips navigation requests. The other strategy, 'freshness', forces all navigation requests through the network.",
"enum": [
"freshness",
"performance"
]
},
"navigationUrls": {
"description": "This optional section enables you to specify a custom list of URLs or URL patterns that will be redirected to the 'index' file.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"index"
],
"type": "object"
} | MIT | en |
ng-docs/angular-cn | 4a5c4042a53d5c564316a81b3bf4d6bfe0fd3c7e | 2022-01-24T22:51:59 | packages/service-worker/config/schema.json | 40 | 2024-05-27T05:00:32.608991Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"appData": {
"description": "This section enables you to pass any data you want that describes this particular version of the app. The SwUpdate service includes that data in the update notifications. Many apps use this section to provide additional information for the display of UI popups, notifying users of the available update.",
"type": "object"
},
"assetGroups": {
"description": "Assets are resources that are part of the app version that update along with the app. They can include resources loaded from the page's origin as well as third-party resources loaded from CDNs and other external URLs. As not all such external URLs may be known at build time, URL patterns can be matched.",
"items": {
"additionalProperties": false,
"properties": {
"cacheQueryOptions": {
"additionalProperties": false,
"description": "Provide options that are passed to Cache#match.",
"properties": {
"ignoreSearch": {
"description": "Whether to ignore the query string in the URL.",
"type": "boolean"
}
},
"type": "object"
},
"installMode": {
"default": "prefetch",
"description": "Determines how the resources are initially cached. 'prefetch' tells the Angular service worker to fetch every single listed resource while it's caching the current version of the app. This is bandwidth-intensive but ensures resources are available whenever they're requested, even if the browser is currently offline. 'lazy' does not cache any of the resources up front. Instead, the Angular service worker only caches resources for which it receives requests. This is an on-demand caching mode. Resources that are never requested will not be cached. This is useful for things like images at different resolutions, so the service worker only caches the correct assets for the particular screen and orientation.",
"enum": [
"prefetch",
"lazy"
]
},
"name": {
"description": "It identifies this particular group of assets between versions of the configuration.",
"type": "string"
},
"resources": {
"additionalProperties": false,
"description": "This section describes the resources to cache.",
"properties": {
"files": {
"description": "Lists patterns that match files in the distribution directory. These can be single files or glob-like patterns that match a number of files.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"urls": {
"description": "Includes both URLs and URL patterns that will be matched at runtime. These resources are not fetched directly and do not have content hashes, but they will be cached according to their HTTP headers. This is most useful for CDNs such as the Google Fonts service. (Negative glob patterns are not supported and '?' will be matched literally; i.e. it will not match any character other than '?'.)",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"updateMode": {
"description": "For resources already in the cache, determines the caching behavior when a new version of the app is discovered. Any resources in the group that have changed since the previous version are updated in accordance with 'updateMode'. 'prefetch' tells the service worker to download and cache the changed resources immediately. 'lazy' tells the service worker to not cache those resources. Instead, it treats them as unrequested and waits until they're requested again before updating them. An 'updateMode' of lazy is only valid if the 'installMode' is also lazy. Defaults to the value `installMode` is set to.",
"enum": [
"prefetch",
"lazy"
]
}
},
"required": [
"name",
"resources"
],
"type": "object"
},
"type": "array"
},
"dataGroups": {
"description": "Policies for caching data requests, such as API requests and other data dependencies. Unlike asset resources, data requests are not versioned along with the app.",
"items": {
"additionalProperties": false,
"properties": {
"cacheConfig": {
"additionalProperties": false,
"description": "This section defines the policy by which matching requests will be cached.",
"properties": {
"cacheOpaqueResponses": {
"description": "Whether to cache opaque responses or not. The default value is 'false' for groups with the 'performance' strategy and 'true' for groups with the 'freshness' strategy. Opaque responses are special in that it is not possible for the service worker to distinguish successful responses from errors. Therefore, be careful with caching opaque responses, especially when combined with a strategy/configuration that could result in a response being retained in the cache for a long time.",
"type": "boolean"
},
"maxAge": {
"description": "Indicates how long responses are allowed to remain in the cache before being considered invalid and evicted. 'maxAge' is a duration string, using the following unit suffixes: d= days, h= hours, m= minutes, s= seconds, u= milliseconds. For example, the string '3d12h' will cache content for up to three and a half days.",
"type": "string"
},
"maxSize": {
"description": "The maximum number of entries, or responses, in the cache. Open-ended caches can grow in unbounded ways and eventually exceed storage quotas, calling for eviction.",
"type": "integer"
},
"strategy": {
"default": "performance",
"description": "The Angular service worker can use either of two caching strategies for data resources. 'performance', the default, optimizes for responses that are as fast as possible. If a resource exists in the cache, the cached version is used. This allows for some staleness, depending on the 'maxAge', in exchange for better performance. This is suitable for resources that don't change often; for example, user avatar images. 'freshness' optimizes for currency of data, preferentially fetching requested data from the network. Only if the network times out, according to 'timeout', does the request fall back to the cache. This is useful for resources that change frequently; for example, account balances.",
"enum": [
"freshness",
"performance"
]
},
"timeout": {
"description": "This duration string specifies the network timeout. The network timeout is how long the Angular service worker will wait for the network to respond before using a cached response, if configured to do so. 'timeout' is a duration string, using the following unit suffixes: d= days, h= hours, m= minutes, s= seconds, u= milliseconds. For example, the string '5s30u' will translate to five seconds and 30 milliseconds of network timeout.",
"type": "string"
}
},
"required": [
"maxSize",
"maxAge"
],
"type": "object"
},
"cacheQueryOptions": {
"additionalProperties": false,
"description": "Provide options that are passed to Cache#match.",
"properties": {
"ignoreSearch": {
"description": "Whether to ignore the query string in the URL.",
"type": "boolean"
}
},
"type": "object"
},
"name": {
"description": "It identifies this particular group of data between versions of the configuration.",
"type": "string"
},
"urls": {
"description": "A list of URL patterns. URLs that match these patterns will be cached according to this data group's policy. (Negative glob patterns are not supported and '?' will be matched literally; i.e. it will not match any character other than '?'.)",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"version": {
"default": 1,
"description": "Occasionally APIs change formats in a way that is not backward-compatible. A new version of the app may not be compatible with the old API format and thus may not be compatible with existing cached resources from that API. 'version' provides a mechanism to indicate that the resources being cached have been updated in a backwards-incompatible way, and that the old cache entries\u2014those from previous versions\u2014should be discarded.",
"type": "integer"
}
},
"required": [
"name",
"urls",
"cacheConfig"
],
"type": "object"
},
"type": "array"
},
"index": {
"description": "Specifies the file that serves as the index page to satisfy navigation requests. Usually this is '/index.html'.",
"type": "string"
},
"navigationRequestStrategy": {
"default": "performance",
"description": "The Angular service worker can use two request strategies for navigation requests. 'performance', the default, skips navigation requests. The other strategy, 'freshness', forces all navigation requests through the network.",
"enum": [
"freshness",
"performance"
]
},
"navigationUrls": {
"description": "This optional section enables you to specify a custom list of URLs or URL patterns that will be redirected to the 'index' file.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"index"
],
"type": "object"
} | MIT | en |
ng-docs/angular-cn | bfa4a966ce9485a3250c5dd55114eae7acd8b2ae | 2020-05-01T16:44:07 | packages/service-worker/config/schema.json | 40 | 2024-05-27T05:00:32.608991Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"appData": {
"description": "This section enables you to pass any data you want that describes this particular version of the app. The SwUpdate service includes that data in the update notifications. Many apps use this section to provide additional information for the display of UI popups, notifying users of the available update.",
"type": "object"
},
"assetGroups": {
"description": "Assets are resources that are part of the app version that update along with the app. They can include resources loaded from the page's origin as well as third-party resources loaded from CDNs and other external URLs. As not all such external URLs may be known at build time, URL patterns can be matched.",
"items": {
"additionalProperties": false,
"properties": {
"cacheQueryOptions": {
"additionalProperties": false,
"description": "Provide options that are passed to Cache#match.",
"properties": {
"ignoreSearch": {
"description": "Whether to ignore the query string in the URL.",
"type": "boolean"
}
},
"type": "object"
},
"installMode": {
"default": "prefetch",
"description": "Determines how the resources are initially cached. 'prefetch' tells the Angular service worker to fetch every single listed resource while it's caching the current version of the app. This is bandwidth-intensive but ensures resources are available whenever they're requested, even if the browser is currently offline. 'lazy' does not cache any of the resources up front. Instead, the Angular service worker only caches resources for which it receives requests. This is an on-demand caching mode. Resources that are never requested will not be cached. This is useful for things like images at different resolutions, so the service worker only caches the correct assets for the particular screen and orientation.",
"enum": [
"prefetch",
"lazy"
]
},
"name": {
"description": "It identifies this particular group of assets between versions of the configuration.",
"type": "string"
},
"resources": {
"additionalProperties": false,
"description": "This section describes the resources to cache.",
"properties": {
"files": {
"description": "Lists patterns that match files in the distribution directory. These can be single files or glob-like patterns that match a number of files.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"urls": {
"description": "Includes both URLs and URL patterns that will be matched at runtime. These resources are not fetched directly and do not have content hashes, but they will be cached according to their HTTP headers. This is most useful for CDNs such as the Google Fonts service. (Negative glob patterns are not supported and '?' will be matched literally; i.e. it will not match any character other than '?'.)",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"updateMode": {
"description": "For resources already in the cache, determines the caching behavior when a new version of the app is discovered. Any resources in the group that have changed since the previous version are updated in accordance with 'updateMode'. 'prefetch' tells the service worker to download and cache the changed resources immediately. 'lazy' tells the service worker to not cache those resources. Instead, it treats them as unrequested and waits until they're requested again before updating them. An 'updateMode' of lazy is only valid if the 'installMode' is also lazy. Defaults to the value `installMode` is set to.",
"enum": [
"prefetch",
"lazy"
]
}
},
"required": [
"name",
"resources"
],
"type": "object"
},
"type": "array"
},
"dataGroups": {
"description": "Policies for caching data requests, such as API requests and other data dependencies. Unlike asset resources, data requests are not versioned along with the app.",
"items": {
"additionalProperties": false,
"properties": {
"cacheConfig": {
"additionalProperties": false,
"description": "This section defines the policy by which matching requests will be cached.",
"properties": {
"maxAge": {
"description": "Indicates how long responses are allowed to remain in the cache before being considered invalid and evicted. 'maxAge' is a duration string, using the following unit suffixes: d= days, h= hours, m= minutes, s= seconds, u= milliseconds. For example, the string '3d12h' will cache content for up to three and a half days.",
"type": "string"
},
"maxSize": {
"description": "The maximum number of entries, or responses, in the cache. Open-ended caches can grow in unbounded ways and eventually exceed storage quotas, calling for eviction.",
"type": "integer"
},
"strategy": {
"default": "performance",
"description": "The Angular service worker can use either of two caching strategies for data resources. 'performance', the default, optimizes for responses that are as fast as possible. If a resource exists in the cache, the cached version is used. This allows for some staleness, depending on the 'maxAge', in exchange for better performance. This is suitable for resources that don't change often; for example, user avatar images. 'freshness' optimizes for currency of data, preferentially fetching requested data from the network. Only if the network times out, according to 'timeout', does the request fall back to the cache. This is useful for resources that change frequently; for example, account balances.",
"enum": [
"freshness",
"performance"
]
},
"timeout": {
"description": "This duration string specifies the network timeout. The network timeout is how long the Angular service worker will wait for the network to respond before using a cached response, if configured to do so. 'timeout' is a duration string, using the following unit suffixes: d= days, h= hours, m= minutes, s= seconds, u= milliseconds. For example, the string '5s30u' will translate to five seconds and 30 milliseconds of network timeout.",
"type": "string"
}
},
"required": [
"maxSize",
"maxAge"
],
"type": "object"
},
"cacheQueryOptions": {
"additionalProperties": false,
"description": "Provide options that are passed to Cache#match.",
"properties": {
"ignoreSearch": {
"description": "Whether to ignore the query string in the URL.",
"type": "boolean"
}
},
"type": "object"
},
"name": {
"description": "It identifies this particular group of data between versions of the configuration.",
"type": "string"
},
"urls": {
"description": "A list of URL patterns. URLs that match these patterns will be cached according to this data group's policy. (Negative glob patterns are not supported and '?' will be matched literally; i.e. it will not match any character other than '?'.)",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"version": {
"default": 1,
"description": "Occasionally APIs change formats in a way that is not backward-compatible. A new version of the app may not be compatible with the old API format and thus may not be compatible with existing cached resources from that API. 'version' provides a mechanism to indicate that the resources being cached have been updated in a backwards-incompatible way, and that the old cache entries\u2014those from previous versions\u2014should be discarded.",
"type": "integer"
}
},
"required": [
"name",
"urls",
"cacheConfig"
],
"type": "object"
},
"type": "array"
},
"index": {
"description": "Specifies the file that serves as the index page to satisfy navigation requests. Usually this is '/index.html'.",
"type": "string"
},
"navigationUrls": {
"description": "This optional section enables you to specify a custom list of URLs or URL patterns that will be redirected to the 'index' file.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"index"
],
"type": "object"
} | MIT | en |
wundergraph/cosmo | d659067fd1d094621788f42bac6d121b0831ebb7 | 2024-05-14T14:36:37 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
},
"rename": {
"description": "Rename is used to rename the named or the matching headers. It can be used with either the named or the matching.",
"examples": [
"X-Rename-Test-Header"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"providers": {
"additionalProperties": false,
"description": "The provider configuration. The provider configuration is used to configure the event-driven federated subscriptions.",
"properties": {
"kafka": {
"description": "The Kafka configuration. The Kafka is used to configure the event-driven federated subscriptions.",
"items": {
"additionalProperties": false,
"properties": {
"authentication": {
"description": "SASL Authentication configuration for the Kafka provider.",
"oneOf": [
{
"properties": {
"sasl_plain": {
"additionalProperties": false,
"description": "Plain SASL Authentication configuration for the Kafka provider.",
"properties": {
"password": {
"description": "The password for plain SASL authentication.",
"type": "string"
},
"username": {
"description": "The username for plain SASL authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
},
"brokers": {
"description": "The list of Kafka brokers. The brokers are used to connect to the Kafka provider.",
"items": {
"format": "hostname-port",
"type": "string"
},
"type": "array"
},
"id": {
"description": "The provider ID. The provider ID is used to identify the provider in the configuration.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"description": "TLS configuration for the Kafka provider. If enabled, it uses SystemCertPool for RootCAs by default.",
"properties": {
"enabled": {
"description": "Enables the TLS.",
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"id",
"brokers"
],
"type": "object"
},
"type": "array"
},
"nats": {
"description": "The NATS configuration. The NATS is used to configure the event-driven federated subscriptions.",
"items": {
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
]
},
{
"properties": {
"user_info": {
"additionalProperties": false,
"description": "Userinfo configuration for the NATS provider.",
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
},
"id": {
"description": "The provider ID. The provider ID is used to identify the provider in the configuration.",
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"id",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"url": {
"default": "redis://localhost:6379",
"description": "The connection URL. The value is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true (default: false), Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"mode": {
"default": "wrapped",
"description": "The mode of error propagation. The supported modes are 'wrapped' (default) and 'pass-through'. The 'wrapped' mode wraps the error in a custom error object to hide internals. The 'pass-through' mode returns the error as is from the Subgraph.",
"enum": [
"wrapped",
"pass-through"
],
"type": "string"
},
"omit_extensions": {
"default": false,
"description": "Omit the extensions field of Subgraph errors. If the value is true (default: false), the extensions field of Subgraph errors will be omitted. This is useful in case you want to avoid leaking internal information to the client. Some users of GraphQL leverage the errors.extensions.code field to implement error handling logic in the client, in which case you might want to set this to false.",
"type": "boolean"
},
"omit_locations": {
"default": true,
"description": "Omit the location field of Subgraph errors. If the value is true (default), the location field of Subgraph errors will be omitted. This is useful because the locations of a Subgraph error is internal to the Subgraph and not relevant to the client.",
"type": "boolean"
},
"propagate_status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true (default: false), Subgraph Response status codes will be propagated to the client in the errors.extensions.code field.",
"type": "boolean"
},
"rewrite_paths": {
"default": true,
"description": "Rewrite the paths of the Subgraph errors. If the value is true (default), the paths of the Subgraph errors will be rewritten to match the Schema of the Federated Graph.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | f7793c58ad7a8024d07c1a287bbe9a2b1c58846f | 2024-04-09T15:35:26 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
],
"properties": {},
"type": "object",
"unevaluatedProperties": false
},
"provider": {
"description": "The events provider. Supported providers include: \"NATS\"",
"enum": [
"NATS"
]
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
}
]
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"url": {
"default": "redis://localhost:6379",
"description": "The connection URL. The value is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true, Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true, Subgraph Response status codes will be propagated to the client.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | fdcc145b053f2aee520c64d534026839b73289e1 | 2024-05-27T15:34:34 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
},
"rename": {
"description": "Rename is used to rename the named or the matching headers. It can be used with either the named or the matching.",
"examples": [
"X-Rename-Test-Header"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"providers": {
"additionalProperties": false,
"description": "The provider configuration. The provider configuration is used to configure the event-driven federated subscriptions.",
"properties": {
"kafka": {
"description": "The Kafka configuration. The Kafka is used to configure the event-driven federated subscriptions.",
"items": {
"additionalProperties": false,
"properties": {
"authentication": {
"description": "SASL Authentication configuration for the Kafka provider.",
"oneOf": [
{
"properties": {
"sasl_plain": {
"additionalProperties": false,
"description": "Plain SASL Authentication configuration for the Kafka provider.",
"properties": {
"password": {
"description": "The password for plain SASL authentication.",
"type": "string"
},
"username": {
"description": "The username for plain SASL authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
},
"brokers": {
"description": "The list of Kafka brokers. The brokers are used to connect to the Kafka provider.",
"items": {
"format": "hostname-port",
"type": "string"
},
"type": "array"
},
"id": {
"description": "The provider ID. The provider ID is used to identify the provider in the configuration.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"description": "TLS configuration for the Kafka provider. If enabled, it uses SystemCertPool for RootCAs by default.",
"properties": {
"enabled": {
"description": "Enables the TLS.",
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"id",
"brokers"
],
"type": "object"
},
"type": "array"
},
"nats": {
"description": "The NATS configuration. The NATS is used to configure the event-driven federated subscriptions.",
"items": {
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
]
},
{
"properties": {
"user_info": {
"additionalProperties": false,
"description": "Userinfo configuration for the NATS provider.",
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
},
"id": {
"description": "The provider ID. The provider ID is used to identify the provider in the configuration.",
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"id",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"deprecated": true,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs. Please use the overrides section because this option is deprecated",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"overrides": {
"additionalProperties": false,
"description": "The configuration to override subgraph config. The config is used to override the config for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"properties": {
"routing_url": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"subscription_protocol": {
"description": "The Subscription protocol of the subgraph. The protocol is used to override the subscription protocol for the subgraph.",
"type": "string"
},
"subscription_url": {
"description": "The Subscription URL of the subgraph. The URL is used to override the subscription URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"subscription_websocket_subprotocol": {
"description": "The Websocket subprotocol of the subgraph. The protocol is used to override the Websocket subprotocol for the subgraph.",
"type": "string"
}
},
"type": "object"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the config for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"url": {
"default": "redis://localhost:6379",
"description": "The connection URL. The value is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true (default: false), Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"mode": {
"default": "wrapped",
"description": "The mode of error propagation. The supported modes are 'wrapped' (default) and 'pass-through'. The 'wrapped' mode wraps the error in a custom error object to hide internals. The 'pass-through' mode returns the error as is from the Subgraph.",
"enum": [
"wrapped",
"pass-through"
],
"type": "string"
},
"omit_extensions": {
"default": false,
"description": "Omit the extensions field of Subgraph errors. If the value is true (default: false), the extensions field of Subgraph errors will be omitted. This is useful in case you want to avoid leaking internal information to the client. Some users of GraphQL leverage the errors.extensions.code field to implement error handling logic in the client, in which case you might want to set this to false.",
"type": "boolean"
},
"omit_locations": {
"default": true,
"description": "Omit the location field of Subgraph errors. If the value is true (default), the location field of Subgraph errors will be omitted. This is useful because the locations of a Subgraph error is internal to the Subgraph and not relevant to the client.",
"type": "boolean"
},
"propagate_status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true (default: false), Subgraph Response status codes will be propagated to the client in the errors.extensions.code field.",
"type": "boolean"
},
"rewrite_paths": {
"default": true,
"description": "Rewrite the paths of the Subgraph errors. If the value is true (default), the paths of the Subgraph errors will be rewritten to match the Schema of the Federated Graph.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"type": "boolean"
},
"export_graphql_variables": {
"default": false,
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces. The default value is false to avoid leaking sensitive information.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"parent_based_sampler": {
"default": true,
"description": "Enable the parent-based sampler. The parent-based sampler is used to sample the traces based on the parent trace. The default value is true.",
"type": "boolean"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"default": 1,
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"default": false,
"description": "Specifies that the router span should be treated as a root Span. Any existing parent span context will be ignored when defining the Span's trace identifiers. This is useful when the router must be the entry point of the trace.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"additionalProperties": false,
"properties": {
"allow_list": {
"default": [
"Authorization"
],
"description": "The names of the headers to forward. The default value is 'Authorization'.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": true,
"description": "Forward upgrade request headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"forward_upgrade_query_params": {
"additionalProperties": false,
"properties": {
"allow_list": {
"default": [
"Authorization"
],
"description": "The names of the query parameters to forward. The default value is 'Authorization'.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | fdcd479b77b979554f6a1151ae52d5430966d06e | 2024-03-19T11:05:00 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true, Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true, Subgraph Response status codes will be propagated to the client.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | ab81771acdc59a62c1f26791cc05db445732c777 | 2024-04-22T16:19:03 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
},
"rename": {
"description": "Rename is used to rename the named or the matching headers. It can be used with either the named or the matching.",
"examples": [
"X-Rename-Test-Header"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
],
"properties": {},
"type": "object",
"unevaluatedProperties": false
},
"provider": {
"description": "The events provider. Supported providers include: \"NATS\"",
"enum": [
"NATS"
]
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
}
]
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"url": {
"default": "redis://localhost:6379",
"description": "The connection URL. The value is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true, Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"mode": {
"default": "wrapped",
"description": "The mode of error propagation. The supported modes are 'wrapped' and 'pass-through'. The 'wrapped' mode wraps the error in a custom error object to hide internals. The 'pass-through' mode returns the error as is from the Subgraph.",
"enum": [
"wrapped",
"pass-through"
],
"type": "string"
},
"status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true, Subgraph Response status codes will be propagated to the client.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | c6e5c313bee098fcd50cca972a2423d28ecbad70 | 2024-03-21T13:14:37 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
],
"properties": {},
"type": "object",
"unevaluatedProperties": false
},
"provider": {
"description": "The events provider. Supported providers include: \"NATS\"",
"enum": [
"NATS"
]
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
}
]
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true, Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true, Subgraph Response status codes will be propagated to the client.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | b1dc2282b3e480a113925e688bffdc8aefd264a2 | 2024-04-18T20:15:12 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
},
"rename": {
"description": "Rename is used to rename the named or the matching headers. It can be used with either the named or the matching.",
"examples": [
"X-Rename-Test-Header"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
],
"properties": {},
"type": "object",
"unevaluatedProperties": false
},
"provider": {
"description": "The events provider. Supported providers include: \"NATS\"",
"enum": [
"NATS"
]
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
}
]
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"url": {
"default": "redis://localhost:6379",
"description": "The connection URL. The value is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true, Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true, Subgraph Response status codes will be propagated to the client.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | 8d26d3618cfe8e7b94ef1e20627849365b01cee0 | 2024-03-13T13:01:02 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | ec700bae0224d3d0180b8d56800f48c9002dcee5 | 2024-02-17T19:10:33 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"items": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3003",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | 9a7bdec06097e9008100408faffc098ad6c04285 | 2024-03-05T13:58:32 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"items": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | bf03bb8fca1838fefebcb150f8924ec52fb8bdb5 | 2024-03-12T18:25:45 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | 0592378a86c23712f7d42ef5ee491bea4e3635ec | 2024-04-25T08:11:09 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
},
"rename": {
"description": "Rename is used to rename the named or the matching headers. It can be used with either the named or the matching.",
"examples": [
"X-Rename-Test-Header"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
],
"properties": {},
"type": "object",
"unevaluatedProperties": false
},
"provider": {
"description": "The events provider. Supported providers include: \"NATS\"",
"enum": [
"NATS"
]
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
}
]
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"url": {
"default": "redis://localhost:6379",
"description": "The connection URL. The value is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true (default: false), Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"mode": {
"default": "wrapped",
"description": "The mode of error propagation. The supported modes are 'wrapped' (default) and 'pass-through'. The 'wrapped' mode wraps the error in a custom error object to hide internals. The 'pass-through' mode returns the error as is from the Subgraph.",
"enum": [
"wrapped",
"pass-through"
],
"type": "string"
},
"omit_extensions": {
"default": false,
"description": "Omit the extensions field of Subgraph errors. If the value is true (default: false), the extensions field of Subgraph errors will be omitted. This is useful in case you want to avoid leaking internal information to the client. Some users of GraphQL leverage the errors.extensions.code field to implement error handling logic in the client, in which case you might want to set this to false.",
"type": "boolean"
},
"omit_locations": {
"default": true,
"description": "Omit the location field of Subgraph errors. If the value is true (default), the location field of Subgraph errors will be omitted. This is useful because the locations of a Subgraph error is internal to the Subgraph and not relevant to the client.",
"type": "boolean"
},
"propagate_status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true (default: false), Subgraph Response status codes will be propagated to the client in the errors.extensions.code field.",
"type": "boolean"
},
"rewrite_paths": {
"default": true,
"description": "Rewrite the paths of the Subgraph errors. If the value is true (default), the paths of the Subgraph errors will be rewritten to match the Schema of the Federated Graph.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | 6c6373087df4520d1c8695a0ee8b2a8514cc3c0a | 2024-02-21T16:33:45 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"items": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | e0345bc02eafd96f553760e58510415c9c4fb654 | 2024-02-19T09:19:45 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"items": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | e35aa262227b29f09ddfdd1ce361c010b769b2da | 2024-05-21T16:43:15 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
},
"rename": {
"description": "Rename is used to rename the named or the matching headers. It can be used with either the named or the matching.",
"examples": [
"X-Rename-Test-Header"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"providers": {
"additionalProperties": false,
"description": "The provider configuration. The provider configuration is used to configure the event-driven federated subscriptions.",
"properties": {
"kafka": {
"description": "The Kafka configuration. The Kafka is used to configure the event-driven federated subscriptions.",
"items": {
"additionalProperties": false,
"properties": {
"authentication": {
"description": "SASL Authentication configuration for the Kafka provider.",
"oneOf": [
{
"properties": {
"sasl_plain": {
"additionalProperties": false,
"description": "Plain SASL Authentication configuration for the Kafka provider.",
"properties": {
"password": {
"description": "The password for plain SASL authentication.",
"type": "string"
},
"username": {
"description": "The username for plain SASL authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
},
"brokers": {
"description": "The list of Kafka brokers. The brokers are used to connect to the Kafka provider.",
"items": {
"format": "hostname-port",
"type": "string"
},
"type": "array"
},
"id": {
"description": "The provider ID. The provider ID is used to identify the provider in the configuration.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"description": "TLS configuration for the Kafka provider. If enabled, it uses SystemCertPool for RootCAs by default.",
"properties": {
"enabled": {
"description": "Enables the TLS.",
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"id",
"brokers"
],
"type": "object"
},
"type": "array"
},
"nats": {
"description": "The NATS configuration. The NATS is used to configure the event-driven federated subscriptions.",
"items": {
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
]
},
{
"properties": {
"user_info": {
"additionalProperties": false,
"description": "Userinfo configuration for the NATS provider.",
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
},
"id": {
"description": "The provider ID. The provider ID is used to identify the provider in the configuration.",
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"id",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"deprecated": true,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs. Please use the overrides section because this option is deprecated",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"overrides": {
"additionalProperties": false,
"description": "The configuration to override subgraph config. The config is used to override the config for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"properties": {
"routing_url": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"subscription_protocol": {
"description": "The Subscription protocol of the subgraph. The protocol is used to override the subscription protocol for the subgraph.",
"type": "string"
},
"subscription_url": {
"description": "The Subscription URL of the subgraph. The URL is used to override the subscription URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"subscription_websocket_subprotocol": {
"description": "The Websocket subprotocol of the subgraph. The protocol is used to override the Websocket subprotocol for the subgraph.",
"type": "string"
}
},
"type": "object"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the config for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"url": {
"default": "redis://localhost:6379",
"description": "The connection URL. The value is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true (default: false), Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"mode": {
"default": "wrapped",
"description": "The mode of error propagation. The supported modes are 'wrapped' (default) and 'pass-through'. The 'wrapped' mode wraps the error in a custom error object to hide internals. The 'pass-through' mode returns the error as is from the Subgraph.",
"enum": [
"wrapped",
"pass-through"
],
"type": "string"
},
"omit_extensions": {
"default": false,
"description": "Omit the extensions field of Subgraph errors. If the value is true (default: false), the extensions field of Subgraph errors will be omitted. This is useful in case you want to avoid leaking internal information to the client. Some users of GraphQL leverage the errors.extensions.code field to implement error handling logic in the client, in which case you might want to set this to false.",
"type": "boolean"
},
"omit_locations": {
"default": true,
"description": "Omit the location field of Subgraph errors. If the value is true (default), the location field of Subgraph errors will be omitted. This is useful because the locations of a Subgraph error is internal to the Subgraph and not relevant to the client.",
"type": "boolean"
},
"propagate_status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true (default: false), Subgraph Response status codes will be propagated to the client in the errors.extensions.code field.",
"type": "boolean"
},
"rewrite_paths": {
"default": true,
"description": "Rewrite the paths of the Subgraph errors. If the value is true (default), the paths of the Subgraph errors will be rewritten to match the Schema of the Federated Graph.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"additionalProperties": false,
"properties": {
"allow_list": {
"default": [
"Authorization"
],
"description": "The names of the headers to forward. The default value is 'Authorization'.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": true,
"description": "Forward upgrade request headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"forward_upgrade_query_params": {
"additionalProperties": false,
"properties": {
"allow_list": {
"default": [
"Authorization"
],
"description": "The names of the query parameters to forward. The default value is 'Authorization'.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | 384fd7e3372479e96fccc4fc771dc4e9f9c84754 | 2024-03-14T15:06:27 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"description": "The provider configuration by source name",
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | 13a1624c16d46a5adca21d82f48de181469621d8 | 2024-05-21T14:08:37 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
},
"rename": {
"description": "Rename is used to rename the named or the matching headers. It can be used with either the named or the matching.",
"examples": [
"X-Rename-Test-Header"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"enable_resolver_debugging": {
"description": "Enable verbose debug logging for the Resolver.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"providers": {
"additionalProperties": false,
"description": "The provider configuration. The provider configuration is used to configure the event-driven federated subscriptions.",
"properties": {
"kafka": {
"description": "The Kafka configuration. The Kafka is used to configure the event-driven federated subscriptions.",
"items": {
"additionalProperties": false,
"properties": {
"authentication": {
"description": "SASL Authentication configuration for the Kafka provider.",
"oneOf": [
{
"properties": {
"sasl_plain": {
"additionalProperties": false,
"description": "Plain SASL Authentication configuration for the Kafka provider.",
"properties": {
"password": {
"description": "The password for plain SASL authentication.",
"type": "string"
},
"username": {
"description": "The username for plain SASL authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
},
"brokers": {
"description": "The list of Kafka brokers. The brokers are used to connect to the Kafka provider.",
"items": {
"format": "hostname-port",
"type": "string"
},
"type": "array"
},
"id": {
"description": "The provider ID. The provider ID is used to identify the provider in the configuration.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"description": "TLS configuration for the Kafka provider. If enabled, it uses SystemCertPool for RootCAs by default.",
"properties": {
"enabled": {
"description": "Enables the TLS.",
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"id",
"brokers"
],
"type": "object"
},
"type": "array"
},
"nats": {
"description": "The NATS configuration. The NATS is used to configure the event-driven federated subscriptions.",
"items": {
"additionalProperties": false,
"properties": {
"authentication": {
"description": "Authentication configuration for the NATS provider.",
"oneOf": [
{
"properties": {
"token": {
"description": "The token for token-based authentication.",
"type": "string"
}
},
"required": [
"token"
]
},
{
"properties": {
"user_info": {
"additionalProperties": false,
"description": "Userinfo configuration for the NATS provider.",
"properties": {
"password": {
"description": "The password for username/password-based authentication.",
"type": "string"
},
"username": {
"description": "The username for username/password-based authentication.",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
},
"id": {
"description": "The provider ID. The provider ID is used to identify the provider in the configuration.",
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"id",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"sign_key": {
"description": "The key used to verify the graph config signature when downloading from the CDN. The same key was used to create the signature in the admission webhook '/validate-config'. If the key is not set, the router will not verify the graph configuration. The key must be a 32 byte long string.",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"url": {
"default": "redis://localhost:6379",
"description": "The connection URL. The value is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"security": {
"additionalProperties": false,
"description": "The configuration for the security. The security is used to configure the security settings for the router.",
"properties": {
"block_mutations": {
"default": false,
"description": "Block mutation Operations. If the value is true, the mutations are blocked.",
"type": "boolean"
},
"block_non_persisted_operations": {
"default": false,
"description": "Block non-persisted Operations. If the value is true, the non-persisted operations are blocked.",
"type": "boolean"
},
"block_subscriptions": {
"description": "Block subscription Operations. If the value is true, the subscriptions are blocked.",
"type": "boolean"
}
},
"type": "object"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"subgraph_error_propagation": {
"additionalProperties": false,
"description": "The configuration for the subgraph error propagation. The subgraph error propagation is used to propagate the errors from the subgraphs to the client.",
"properties": {
"enabled": {
"default": false,
"description": "Enable error propagation. If the value is true (default: false), Subgraph errors will be propagated to the client.",
"type": "boolean"
},
"mode": {
"default": "wrapped",
"description": "The mode of error propagation. The supported modes are 'wrapped' (default) and 'pass-through'. The 'wrapped' mode wraps the error in a custom error object to hide internals. The 'pass-through' mode returns the error as is from the Subgraph.",
"enum": [
"wrapped",
"pass-through"
],
"type": "string"
},
"omit_extensions": {
"default": false,
"description": "Omit the extensions field of Subgraph errors. If the value is true (default: false), the extensions field of Subgraph errors will be omitted. This is useful in case you want to avoid leaking internal information to the client. Some users of GraphQL leverage the errors.extensions.code field to implement error handling logic in the client, in which case you might want to set this to false.",
"type": "boolean"
},
"omit_locations": {
"default": true,
"description": "Omit the location field of Subgraph errors. If the value is true (default), the location field of Subgraph errors will be omitted. This is useful because the locations of a Subgraph error is internal to the Subgraph and not relevant to the client.",
"type": "boolean"
},
"propagate_status_codes": {
"default": false,
"description": "Propagate Subgraph status codes. If the value is true (default: false), Subgraph Response status codes will be propagated to the client in the errors.extensions.code field.",
"type": "boolean"
},
"rewrite_paths": {
"default": true,
"description": "Rewrite the paths of the Subgraph errors. If the value is true (default), the paths of the Subgraph errors will be rewritten to match the Schema of the Federated Graph.",
"type": "boolean"
}
},
"type": "object"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"additionalProperties": false,
"properties": {
"allow_list": {
"default": [
"Authorization"
],
"description": "The names of the headers to forward. The default value is 'Authorization'.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": true,
"description": "Forward upgrade request headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"forward_upgrade_query_params": {
"additionalProperties": false,
"properties": {
"allow_list": {
"default": [
"Authorization"
],
"description": "The names of the query parameters to forward. The default value is 'Authorization'.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
wundergraph/cosmo | 73d296a3cfec82b7d5c9efbe24ee0c389c43beb8 | 2024-03-09T11:13:22 | router/pkg/config/config.schema.json | 563 | 2024-05-28T19:37:06.575706Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"traffic_shaping_header_rule": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"default": {
"description": "The default value of the header in case it is not present in the request.",
"examples": [
"default-value"
],
"type": "string"
},
"matching": {
"description": "The matching rule for the header. The matching rule is a regular expression that is used to match the header. Can't be used with 'named'.",
"examples": [
"(?i)^X-Custom-.*"
],
"type": "string"
},
"named": {
"description": "The name of the header to match. Use the canonical version e.g. X-Test-Header. Can't be used with 'matching'.",
"examples": [
"X-Test-Header"
],
"type": "string"
},
"op": {
"description": "The operation to perform on the header. The supported operations are 'propagate'. The 'propagate' operation is used to propagate the header to the subgraphs.",
"enum": [
"propagate"
],
"examples": [
"propagate"
],
"type": "string"
}
},
"required": [
"op"
],
"type": "object"
}
},
"properties": {
"authentication": {
"additionalProperties": false,
"description": "The configuration for the authentication. The authentication is used to authenticate the incoming requests. We currently support JWK (JSON Web Key) authentication.",
"properties": {
"providers": {
"items": {
"additionalProperties": false,
"properties": {
"jwks": {
"additionalProperties": false,
"properties": {
"header_names": {
"default": [
"Authorization"
],
"description": "The names of the headers. The headers are used to extract the token from the request. The default value is 'Authorization'",
"items": {
"type": "string"
},
"type": "array"
},
"header_value_prefixes": {
"default": [
"Bearer"
],
"description": "The prefixes of the header values. The prefixes are used to extract the token from the header value. The default value is 'Bearer'",
"items": {
"type": "string"
},
"type": "array"
},
"refresh_interval": {
"default": "1m",
"description": "The interval at which the JWKs are refreshed. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"url": {
"description": "The URL of the JWKs. The JWKs are used to verify the JWT (JSON Web Token). The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": {
"description": "The name of the authentication provider. The name is used to identify the provider in the configuration.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"authorization": {
"additionalProperties": false,
"properties": {
"reject_operation_if_unauthorized": {
"description": "Reject the operation if the request is not authorized. If the value is true, the operation is rejected if the request is not authorized.",
"type": "boolean"
},
"require_authentication": {
"description": "Ensure that the request is authenticated. If the value is true, the request must be authenticated. If the value is false, the request does not need to be authenticated.",
"type": "boolean"
}
},
"type": "object"
},
"cdn": {
"additionalProperties": false,
"description": "The configuration for the CDN. The CDN is used to fetch the schema and configurations from the CDN.",
"properties": {
"cache_size": {
"bytes": {
"minimum": "10MB"
},
"default": "100MB",
"description": "The size of the cache used. The default value is 100MB.",
"format": "bytes-string",
"type": "string"
},
"url": {
"description": "The URL of the CDN. The URL is used to fetch the schema and the configuration from the CDN. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
}
},
"type": "object"
},
"cluster": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the cluster. This is used to identify the cluster in the control plane and in the metrics.",
"type": "string"
}
},
"type": "object"
},
"compliance": {
"additionalProperties": false,
"description": "The configuration for the compliance. Includes for example the configuration for the anonymization of the IP addresses.",
"properties": {
"anonymize_ip": {
"additionalProperties": false,
"description": "The configuration for the anonymization of the IP addresses. Redaction is applied to the IP addresses in the traces and logs to protect the privacy of the users.",
"properties": {
"enabled": {
"description": "Enable the anonymization of the IP addresses. The default value is true.",
"type": "boolean"
},
"method": {
"default": "redact",
"description": "The method used to anonymize the IP addresses. The supported methods are 'redact' and 'hash'. The default value is 'redact'. The 'redact' method replaces the IP addresses with the string '[REDACTED]'. The 'hash' method hashes the IP addresses using the SHA-256 algorithm.",
"enum": [
"redact",
"hash"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"config_path": {
"description": "The path of the router configuration file. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"controlplane_url": {
"default": "https://cosmo-cp.wundergraph.com",
"description": "The URL of the control plane. The URL is used to register the router in the control plane. The URL is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allow_credentials": {
"default": true,
"description": "The allowed credentials. The default value is to allow credentials. This allows the browser to send cookies and authentication headers.",
"type": "boolean"
},
"allow_headers": {
"default": [
"Origin",
"Content-Length",
"Content-Type",
"Authorization",
"Origin",
"Content-Length",
"Content-Type",
"Graphql-Client-Name",
"Graphql-Client-Version",
"Apollo-Graphql-Client-Name",
"Apollo-Graphql-Client-Version",
"x-wg-trace",
"x-wg-token",
"traceparent",
"tracestate"
],
"description": "The allowed HTTP headers. The default value is to allow all headers. Default headers are always appended to the list of allowed headers.",
"items": {
"type": "string"
},
"type": "array"
},
"allow_methods": {
"default": [
"GET",
"POST",
"HEAD"
],
"description": "The allowed HTTP methods. The default value is to allow the methods 'GET', 'POST', and 'HEAD'.",
"items": {
"enum": [
"GET",
"POST",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"allow_origins": {
"default": [
"*"
],
"description": "The allowed origins. The default value is to allow all origins. The value can be a list of origins or the wildcard '*'.",
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"default": "5m",
"description": "The maximum age of the preflight request. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5m"
},
"type": "string"
}
},
"type": "object"
},
"dev_mode": {
"default": false,
"description": "Enable the development mode. The development mode is used to enable the development features like ART (Advanced Request Tracing) and pretty logs.",
"type": "boolean"
},
"engine": {
"additionalProperties": false,
"description": "The configuration for the engine. The engine is used to execute the GraphQL queries, mutations and subscriptions. Only modify this if you know what you are doing.",
"properties": {
"debug": {
"additionalProperties": false,
"description": "The debug configuration. The debug configuration is used to enable the debug mode for the engine.",
"properties": {
"configuration_visitor": {
"description": "Print the configuration visitor.",
"type": "boolean"
},
"datasource_visitor": {
"description": "Print the datasource visitor.",
"type": "boolean"
},
"planning_visitor": {
"description": "Print the planning visitor.",
"type": "boolean"
},
"print_node_suggestions": {
"description": "Print the node suggestions.",
"type": "boolean"
},
"print_operation_enable_ast_refs": {
"description": "Print the operation enable AST refs.",
"type": "boolean"
},
"print_operation_transformations": {
"description": "Print the operation transformations.",
"type": "boolean"
},
"print_planning_paths": {
"description": "Print the planning paths.",
"type": "boolean"
},
"print_query_plans": {
"description": "Print the query plans.",
"type": "boolean"
},
"report_memory_usage": {
"description": "Print the memory usage.",
"type": "boolean"
},
"report_websocket_connections": {
"description": "Print the websocket connections.",
"type": "boolean"
}
},
"type": "object"
},
"enable_execution_plan_cache_response_header": {
"description": "Enable the execution plan cache response header. The execution plan cache response header is used to cache the execution plan in the client.",
"type": "boolean"
},
"enable_request_tracing": {
"default": true,
"description": "Enable the advanced request tracing. See https://cosmo-docs.wundergraph.com/router/advanced-request-tracing-art for more information.",
"type": "boolean"
},
"enable_single_flight": {
"default": true,
"description": "Enable the single flight. The single flight is used to deduplicate the requests to the same subgraphs.",
"type": "boolean"
},
"enable_websocket_epoll_kqueue": {
"default": true,
"description": "Enable the websocket epoll kqueue. The websocket epoll kqueue is used to optimize the websocket connections. Only available on Linux and MacOS.",
"type": "boolean"
},
"epoll_kqueue_conn_buffer_size": {
"default": 128,
"description": "The buffer size for the epoll kqueue connection.",
"type": "integer"
},
"epoll_kqueue_poll_timeout": {
"default": "1s",
"description": "The timeout for the epoll kqueue poll. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"execution_plan_cache_size": {
"default": 10000,
"description": "The size of the execution plan cache.",
"type": "integer"
},
"max_concurrent_resolvers": {
"default": 1024,
"description": "The maximum number of concurrent resolvers.",
"type": "integer"
},
"websocket_read_timeout": {
"default": "5s",
"description": "The timeout for the websocket read. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"events": {
"additionalProperties": false,
"description": "The configuration for EDFS. See https://cosmo-docs.wundergraph.com/router/event-driven-federated-subscriptions-edfs for more information.",
"properties": {
"sources": {
"items": {
"additionalProperties": false,
"properties": {
"provider": {
"description": "The provider of the events. The supported providers are 'NATS'.",
"enum": [
"NATS"
],
"type": "string"
},
"url": {
"description": "The provider URL. The URL is used to connect to the provider.",
"format": "url",
"type": "string"
}
},
"required": [
"provider",
"url"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"grace_period": {
"default": "20s",
"description": "The grace period before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"graph": {
"additionalProperties": false,
"properties": {
"token": {
"description": "The token used to authenticate with other component from Cosmo. Can be ommitted if the router is started with a static execution config.",
"type": "string"
}
},
"type": "object"
},
"graphql_metrics": {
"additionalProperties": false,
"properties": {
"collector_endpoint": {
"description": "The endpoint to which the GraphQL metrics are collected. The endpoint is specified as a string with the format 'scheme://host:port'.",
"format": "http-url",
"type": "string"
},
"enabled": {
"description": "Enable the collection of the GraphQL metrics. The default value is true.",
"type": "boolean"
}
},
"type": "object"
},
"graphql_path": {
"default": "/graphql",
"description": "The path of the GraphQL endpoint. The GraphQL endpoint is used to send the GraphQL queries, subscriptions and mutations. The default value is '/graphql'.",
"format": "x-uri",
"type": "string"
},
"headers": {
"additionalProperties": false,
"description": "The configuration for the headers. The headers rules are used to modify the headers of the incoming requests and how they are propagated to your subgraphs. See https://cosmo-docs.wundergraph.com/router/proxy-capabilities#forward-http-headers-to-subgraphs for more information.",
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
}
},
"subgraphs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"request": {
"items": {
"$ref": "#/definitions/traffic_shaping_header_rule"
},
"type": "array"
}
},
"type": "object"
},
"type": "object"
}
},
"type": "object"
},
"health_check_path": {
"default": "/health",
"description": "The path of the health check endpoint. The health check endpoint is used to check the health of the router. The default value is '/health'.",
"format": "x-uri",
"type": "string"
},
"instance_id": {
"description": "The unique identifier of the instance. This is used to identify the instance in the control plane and in the metrics.",
"type": "string"
},
"introspection_enabled": {
"default": true,
"description": "Enable the GraphQL introspection. The GraphQL introspection allows you to query the schema of the GraphQL API. The default value is true. If the value is false, the GraphQL introspection is disabled. In production, it is recommended to disable the introspection.",
"type": "boolean"
},
"json_log": {
"default": true,
"description": "Enable the JSON log format. The JSON log format is used to log the logs in JSON format. The default value is true. If the value is false, the logs are logged a human friendly text format.",
"type": "boolean"
},
"listen_addr": {
"default": "localhost:3002",
"description": "The address on which the router listens for incoming requests. The address is specified as a string with the format 'host:port'.",
"format": "hostname-port",
"type": "string"
},
"liveness_check_path": {
"default": "/health/live",
"description": "The path of the liveness check endpoint. The liveness check endpoint is used to check the liveness of the router. The default value is '/health/live'.",
"format": "x-uri",
"type": "string"
},
"localhost_fallback_inside_docker": {
"default": true,
"description": "Enable the localhost fallback inside Docker. The localhost fallback is used to resolve the localhost address when running the router inside a Docker container. This should be only enabled for development and testing.",
"type": "boolean"
},
"log_level": {
"default": "info",
"description": "The log level. The log level is used to control the verbosity of the logs. The default value is 'info'.",
"enum": [
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"type": "string"
},
"modules": {
"additionalProperties": {
"additionalProperties": true,
"description": "The configuration for the module. The key is the name of the module specified in the code.",
"type": "object"
},
"description": "The configuration for the modules. The modules are used to extend the functionality of the router. The modules are specified as a map of module names to module configurations. It needs to match with the name of the module and the configuration of the module. See https://cosmo-docs.wundergraph.com/router/custom-modules for more information.",
"type": "object"
},
"override_routing_url": {
"additionalProperties": false,
"description": "The configuration for the override routing URL. The override routing URL is used to override the routing URL for subgraphs.",
"properties": {
"subgraphs": {
"additionalProperties": {
"description": "The URL of the subgraph. The URL is used to override the routing URL for the subgraph.",
"format": "http-url",
"type": "string"
},
"description": "The configuration for the subgraphs. The subgraphs are used to override the routing URL for the subgraphs.",
"type": "object"
}
},
"type": "object"
},
"playground_enabled": {
"default": true,
"description": "Enable the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is true. If the value is false, the GraphQL Playground is disabled.",
"type": "boolean"
},
"playground_path": {
"default": "/",
"description": "The path of the GraphQL Playground. The GraphQL Playground is a web-based GraphQL IDE that allows you to interact with the GraphQL API. The default value is '/'.",
"format": "x-uri",
"type": "string"
},
"poll_interval": {
"default": "10s",
"description": "The interval at which the router polls the CDN for updates. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"rate_limit": {
"additionalProperties": false,
"description": "The configuration for the rate limit. The rate limit is used to limit the number of requests that can be made to the router.",
"properties": {
"debug": {
"description": "Enable the debug mode for the rate limit.",
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"simple_strategy": {
"additionalProperties": false,
"properties": {
"burst": {
"description": "The maximum number of requests that are allowed to exceed the rate. The burst is specified as a number of requests.",
"minimum": 1,
"type": "integer"
},
"period": {
"description": "The period of time over which the rate limit is enforced. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"rate": {
"description": "The rate at which the requests are allowed. The rate is specified as a number of requests per second.",
"minimum": 1,
"type": "integer"
},
"reject_exceeding_requests": {
"description": "Reject the requests that exceed the rate limit. If the value is true, the requests that exceed the rate limit are rejected.",
"type": "boolean"
}
},
"required": [
"rate",
"burst",
"period"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"properties": {
"addr": {
"default": "localhost:6379",
"description": "The url of the redis server. The url is specified as a string with the format 'scheme://host:port'.",
"format": "url",
"type": "string"
},
"key_prefix": {
"default": "cosmo_rate_limit",
"description": "The prefix of the keys used to store the rate limit data.",
"type": "string"
},
"password": {
"description": "The password of the redis server.",
"type": "string"
}
},
"type": "object"
},
"strategy": {
"description": "The strategy used to enforce the rate limit. The supported strategies are 'simple'.",
"enum": [
"simple"
],
"type": "string"
}
},
"type": "object"
},
"readiness_check_path": {
"default": "/health/ready",
"description": "The path of the readiness check endpoint. The readiness check endpoint is used to check the readiness of the router. The default value is '/health/ready'.",
"format": "x-uri",
"type": "string"
},
"router_config_path": {
"description": "The path of the router execution config file. This file contains the information how your graph is resolved and configured. The path is specified as a string with the format 'path/to/file'.",
"format": "file-path",
"type": "string"
},
"router_registration": {
"default": true,
"description": "Enable the router registration. The router registration is used to register the router in the control plane. The default value is true. This should not be modified unless you know what you are doing.",
"type": "boolean"
},
"shutdown_delay": {
"default": "60s",
"description": "The delay before the router shuts down. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "15s"
},
"type": "string"
},
"telemetry": {
"additionalProperties": false,
"description": "The configuration for the telemetry. The telemetry is used to collect and export the traces and metrics.",
"properties": {
"metrics": {
"additionalProperties": false,
"description": "The configuration for the collection and export of metrics. The metrics are collected and exported using the OpenTelemetry protocol (OTLP) and Prometheus.",
"properties": {
"otlp": {
"additionalProperties": false,
"description": "The configuration for the OpenTelemetry protocol (OTLP). The OTLP is used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"description": "Enable the collection of metrics.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the metrics. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"endpoint": {
"description": "The endpoint to which the metrics are exported.",
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter protocol to use to export metrics. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The headers to send with the request. Use this to set the authentication headers.",
"type": "object"
},
"path": {
"default": "/v1/metrics",
"description": "The path to which the metrics are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"exporter",
"endpoint"
],
"type": "object"
},
"type": "array"
},
"router_runtime": {
"default": true,
"description": "Enable the collection of metrics for the router runtime.",
"type": "boolean"
}
},
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "The configuration for the Prometheus metrics. The Prometheus metrics are used to collect and export the metrics.",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"exclude_metric_labels": {
"description": "The metric labels to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"exclude_metrics": {
"description": "The metrics to exclude from the Prometheus metrics. Accepts a list of Go regular expressions. Use https://regex101.com/ to test your regular expressions.",
"items": {
"type": "string"
},
"type": "array"
},
"listen_addr": {
"default": "localhost:8088",
"description": "The address on which the metrics are served.",
"format": "hostname-port",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to which the metrics are served.",
"format": "x-uri",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_name": {
"default": "cosmo-router",
"description": "The name of the service. The name is used to identify the service in the traces and metrics. The default value is 'cosmo-router'.",
"type": "string"
},
"tracing": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"export_graphql_variables": {
"description": "Enable the export of the GraphQL variables. The GraphQL variables are exported with the traces.",
"type": "boolean"
},
"exporters": {
"description": "The exporters to use to export the traces. If no exporters are specified, the default Cosmo Cloud exporter is used. If you override, please make sure to include the default exporter.",
"items": {
"additionalProperties": false,
"properties": {
"batch_timeout": {
"default": "10s",
"description": "The maximum time to wait before exporting the traces. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"disabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"export_timeout": {
"default": "30s",
"description": "The maximum time to wait for the export to complete. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"maximum": "2m",
"minimum": "5s"
},
"type": "string"
},
"exporter": {
"default": "http",
"description": "The exporter to use for the traces. The supported exporters are 'http' and 'grpc'.",
"enum": [
"http",
"grpc"
],
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"path": {
"default": "/v1/traces",
"description": "The path to which the traces are exported.",
"format": "x-uri",
"type": "string"
}
},
"required": [
"endpoint"
],
"type": "object"
},
"type": "array"
},
"propagation": {
"additionalProperties": false,
"properties": {
"b3": {
"description": "Enable the B3 propagation. See https://github.com/openzipkin/b3-propagation (zipkin) for more information.",
"type": "boolean"
},
"baggage": {
"description": "Enable the baggage propagation. See https://www.w3.org/TR/baggage/ for more information.",
"type": "boolean"
},
"jaeger": {
"description": "Enable the Jaeger propagation. See https://www.jaegertracing.io/ (compliant with opentracing) for more information.",
"type": "boolean"
},
"trace_context": {
"description": "Enable the trace context propagation. See https://www.w3.org/TR/trace-context/ for more information.",
"type": "boolean"
}
},
"type": "object"
},
"sampling_rate": {
"description": "The sampling rate for the traces. The value must be between 0 and 1. If the value is 0, no traces will be sampled. If the value is 1, all traces will be sampled. The default value is 1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"with_new_root": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"tls": {
"additionalProperties": false,
"description": "The configuration for the TLS. The TLS is used to enable the TLS for the router.",
"properties": {
"server": {
"additionalProperties": false,
"description": "The configuration for the server TLS. Useful e.g. if you want to establish a secure connection from the Load-Balancer to the router.",
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file is used to enable the TLS.",
"format": "file-path",
"type": "string"
},
"client_auth": {
"additionalProperties": false,
"description": "The configuration for the client authentication. The client authentication is used to authenticate the clients using the provided certificate.",
"properties": {
"cert_file": {
"description": "The path to the certificate file. The certificate file against which the client certificates are verified.",
"format": "file-path",
"type": "string"
},
"required": {
"default": false,
"description": "Require clients to present a valid certificate that is verified. The default value is false. It is recommended to enable the client authentication to enforce mutual TLS. If false and a cert is provided, the client authentication is optional but in case the client presents a certificate, it will be verified.",
"type": "boolean"
}
},
"required": [
"cert_file"
],
"type": "object"
},
"enabled": {
"description": "Enable the TLS. The default value is false.",
"type": "boolean"
},
"key_file": {
"description": "The path to the key file. The key file is used to enable the TLS.",
"format": "file-path",
"type": "string"
}
},
"then": {
"required": [
"cert_file",
"key_file"
]
},
"type": "object"
}
},
"type": "object"
},
"traffic_shaping": {
"additionalProperties": false,
"description": "The configuration for the traffic shaping. Configure rules for traffic shaping like maximum request body size, timeouts, retry behavior, etc. See https://cosmo-docs.wundergraph.com/router/traffic-shaping for more information.",
"properties": {
"all": {
"additionalProperties": false,
"description": "The configuration for all subgraphs. The configuration is used to configure the traffic shaping for all subgraphs.",
"properties": {
"dial_timeout": {
"description": "The dial timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"expect_continue_timeout": {
"description": "The expect continue timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_idle_timeout": {
"description": "The keep alive idle timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"keep_alive_probe_interval": {
"description": "The keep alive probe interval. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "5s"
},
"type": "string"
},
"request_timeout": {
"description": "The request timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"duration": {
"minimum": "1s"
},
"type": "string"
},
"response_header_timeout": {
"description": "The response header timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"retry": {
"additionalProperties": false,
"description": "The retry configuration. The retry configuration is used to configure the retry behavior for the subgraphs requests. See https://cosmo-docs.wundergraph.com/router/traffic-shaping#automatic-retry for more information.",
"properties": {
"algorithm": {
"description": "The algorithm used to calculate the retry interval. The supported algorithms are 'backoff_jitter'.",
"enum": [
"backoff_jitter"
],
"type": "string"
},
"enabled": {
"type": "boolean"
},
"interval": {
"default": "3s",
"description": "The time duration between each retry attempt. Increase with every retry. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
},
"max_attempts": {
"default": 5,
"description": "The maximum number of attempts. The default value is 5.",
"minimum": 1,
"type": "integer"
},
"max_duration": {
"default": "10s",
"description": "The maximum allowable duration between retries (random). The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"tls_handshake_timeout": {
"description": "The TLS handshake timeout. The period is specified as a string with a number and a unit, e.g. 10ms, 1s, 1m, 1h. The supported units are 'ms', 's', 'm', 'h'.",
"format": "go-duration",
"type": "string"
}
},
"type": "object"
},
"router": {
"additionalProperties": false,
"properties": {
"max_request_body_size": {
"bytes": {
"minimum": "1MB"
},
"description": "The maximum request body size. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB. The supported units are 'KB', 'MB', 'GB'.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"version": {
"description": "The version of the configuration file. This is used to ensure that the configuration file is compatible.",
"enum": [
"1"
],
"type": "string"
},
"websocket": {
"additionalProperties": false,
"description": "The configuration for the WebSocket transport. The WebSocket transport is used to enable the WebSocket transport for the GraphQL subscriptions.",
"properties": {
"absinthe_protocol": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enable Absinthe protocol. The default value is true.",
"type": "boolean"
},
"handler_path": {
"default": "/absinthe/socket",
"description": "The path to mount the Absinthe Protocol Handler on. The default value is '/absinthe/socket'.",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": true,
"description": "Enable WebSocket transport. The default value is true.",
"type": "boolean"
},
"forward_initial_payload": {
"default": true,
"description": "Forward the initial payload in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_headers": {
"default": true,
"description": "Forward upgrade request Headers in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
},
"forward_upgrade_query_params": {
"default": true,
"description": "Forward upgrade request query parameters in the extensions payload when starting a subscription on a Subgraph. The default value is true.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
asterfusion/Helium_DPU | 869df70b1f669195fb84274a35373aac982f0ed2 | 2023-07-05T12:41:30 | Helium/DPDK/dpdk-stable-22.11.2/dts/framework/config/conf_yaml_schema.json | 29 | 2024-05-27T04:38:51.883416Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"definitions": {
"node_name": {
"description": "A unique identifier for a node",
"type": "string"
}
},
"properties": {
"executions": {
"items": {
"additionalProperties": false,
"properties": {
"system_under_test": {
"$ref": "#/definitions/node_name"
}
},
"required": [
"system_under_test"
],
"type": "object"
},
"minimum": 1,
"type": "array"
},
"nodes": {
"items": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "A hostname from which the node running DTS can access this node. This can also be an IP address.",
"type": "string"
},
"name": {
"description": "A unique identifier for this node",
"type": "string"
},
"password": {
"description": "The password to use on this node. Use only as a last resort. SSH keys are STRONGLY preferred.",
"type": "string"
},
"user": {
"description": "The user to access this node with.",
"type": "string"
}
},
"required": [
"name",
"hostname",
"user"
],
"type": "object"
},
"minimum": 1,
"type": "array"
}
},
"required": [
"executions",
"nodes"
],
"title": "DTS Config Schema",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | cd794291acda449195bb050ec1f097202290f2ea | 2021-10-04T14:38:22 | StaticData/ExcelTransformConfig/exceltransformconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/exceltransformconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to transform cells",
"properties": {
"description": {
"type": "string"
},
"ignoredCells": {
"items": {
"properties": {
"column": {
"type": "integer"
},
"forceLanguage": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id",
"column"
],
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pluralMap": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"items": {
"maxItems": 4,
"minItems": 2,
"type": [
"integer",
"null"
]
},
"type": "array"
}
},
"type": "object"
},
"replacementTemplates": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"rules": {
"items": {
"properties": {
"replaceTo": {
"type": "string"
},
"stringPattern": {
"type": "string"
},
"targetGroups": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"targetGroups",
"replaceTo"
],
"type": "object"
},
"type": "array"
},
"sourceLanguages": {
"items": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
},
"sourceReplacements": {
"items": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"targetGroups": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"items": {
"minItems": 1,
"type": [
"integer"
]
},
"type": [
"array",
"integer"
]
}
},
"type": "object"
},
"targetLanguage": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
}
},
"required": [
"name",
"targetLanguage",
"sourceLanguages",
"targetGroups",
"rules"
],
"title": "Excel String Transformation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 8940ef0d95504d657a88c1d54f9870dbf978768b | 2021-09-18T16:30:49 | StaticData/ExcelTransformConfig/exceltransformconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/exceltransformconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to transform cells",
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"pluralMap": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"items": {
"maxItems": 4,
"minItems": 2,
"type": [
"integer",
"null"
]
},
"type": "array"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"rules": {
"items": {
"properties": {
"replaceTo": {
"type": "string"
},
"stringPattern": {
"type": "string"
},
"targetGroups": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"targetGroups",
"replaceTo"
],
"type": "object"
},
"type": "array"
},
"sourceLanguages": {
"items": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
},
"targetGroups": {
"patternProperties": {
".*": {
"items": {
"minItems": 1,
"type": [
"integer"
]
},
"type": [
"array",
"integer"
]
}
},
"type": "object"
},
"targetLanguage": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
}
},
"required": [
"name",
"targetLanguage",
"sourceLanguages",
"targetGroups",
"rules"
],
"title": "Excel String Transformation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | d815d7ef89b37f9dc5c59f5bdfe50410fda79d44 | 2021-09-11T12:59:46 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"glyphGap": {
"default": 1,
"minimum": 0,
"type": "integer"
},
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer",
"array"
]
}
},
"type": "object"
}
},
"type": "object"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"minimum": 1,
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent will be used. If string is given, ascent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"descent": {
"default": null,
"description": "Descent of the font. If null is given, the maximum descent will be used. If string is given, descent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"textureHeight": {
"default": 1024,
"type": "integer"
},
"textureWidth": {
"default": 1024,
"type": "integer"
}
},
"required": [
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 56955570a744b294b7c7ecbe88c8ac04fc604fb0 | 2021-09-11T15:51:11 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"glyphGap": {
"default": 1,
"minimum": 0,
"type": "integer"
},
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer",
"array"
]
}
},
"type": "object"
}
},
"type": "object"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"minimum": 1,
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent will be used. If string is given, ascent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"descent": {
"default": null,
"description": "Descent of the font. If null is given, the maximum descent will be used. If string is given, descent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"extendRange": {
"default": true,
"description": "Whether to extend the character coverage of this font. If false, then will only replace font if replace is true. If replace is false and this is true, then this entry will do nothing.",
"type": "boolean"
},
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"textureHeight": {
"default": 1024,
"type": "integer"
},
"textureWidth": {
"default": 1024,
"type": "integer"
}
},
"required": [
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | bc96daa0e438cd8a7088530a397270862a960019 | 2021-09-11T07:57:51 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent will be used. If string is given, ascent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"descent": {
"default": null,
"description": "Descent of the font. If null is given, the maximum descent will be used. If string is given, descent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | fdcf51fe0d676c663db74cd830cc6b5ef9d8a52a | 2021-10-08T06:33:43 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"compactLayout": {
"default": false,
"description": "Let each glyph have different height to save space.",
"type": "boolean"
},
"description": {
"type": "string"
},
"fontRequirements": {
"description": "Check whether the required fonts are installed, and instruct the user to install the fonts.",
"items": {
"properties": {
"homepage": {
"description": "Website for this font."
},
"installInstructions": {
"patternProperties": {
"": {
"type": "string"
}
},
"type": [
"string",
"object"
]
},
"name": {
"description": "Name of font family, identifiable from system.",
"type": "string"
},
"requiredStyles": {
"description": "Specify required font styles. If not specified, any font face matching the name will make this requirement pass.",
"items": {
"properties": {
"stretch": {
"description": "Strech of the font.",
"enum": [
"normal",
"medium",
"regular",
"condensed",
"expanded",
"ultra-condensed",
"extra-condensed",
"semi-condensed",
"semi-expanded",
"extra-expanded",
"ultra-expanded"
],
"type": "string"
},
"style": {
"description": "Style of the font.",
"enum": [
"normal",
"italic",
"oblique"
],
"type": "string"
},
"weight": {
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"stretdch",
"style",
"weight"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"installInstructions"
],
"type": "object"
},
"type": "array"
},
"gameIndexFiles": {
"description": "Define game index files to be used.",
"patternProperties": {
"": {
"properties": {
"autoDetectIndexExpac": {
"default": "ffxiv",
"description": "Choose a game expansion. (Example: ffxiv, ex1, ex2, ex3, ...)",
"type": "string"
},
"autoDetectIndexFile": {
"default": "000000",
"description": "Choose a game data file name. (Example: 000000, 0a0000, ...)",
"type": "string"
},
"autoDetectRegion": {
"default": "",
"description": "Choose a game region to automatically detect from. Leave it empty to skip.",
"enum": [
"",
"International",
"Chinese",
"Korean"
],
"type": "string"
},
"fallbackPathList": {
"description": "List paths to index files to use if nothing from path list nor auto detection was found.",
"items": {
"type": "string"
},
"type": "array"
},
"fallbackPrompt": {
"description": "Prompt to display if no files were found. Keys are regular expression for locale names (case insensitive; ex. en-US), and will use the first match. If none in user's language list is found, the first one will be used.",
"patternProperties": {
"": {
"type": "string"
}
},
"type": [
"string",
"object"
]
},
"pathList": {
"description": "If path to index file specified here exists, skip auto detect and use it.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"glyphGap": {
"default": 1,
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"offsetXModifier": {
"default": 0,
"type": "integer"
},
"ranges": {
"default": {},
"description": "Define sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer",
"array"
]
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"sources": {
"description": "Define font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"advanceWidthDelta": {
"default": 0,
"description": "Adjust advance width of this source font face.",
"type": "integer"
},
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^freetype:": {
"properties": {
"advanceWidthDelta": {
"default": 0,
"description": "Adjust advance width of this source font face.",
"type": "integer"
},
"faceIndex": {
"default": 0,
"description": "Index of font face to use in the specified font file.",
"type": "integer"
},
"familyName": {
"description": "Name of font installed on your system. If both fontFile and familyName are specified, fontFile will take precedence, and fall back to familyName if fontFile does not exist.",
"type": "string"
},
"fontFile": {
"description": "Path to font file.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"loadFlags": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "FreeType load flags. Refer to https://www.freetype.org/freetype2/docs/reference/ft2-base_interface.html#ft_load_xxx for possible values. Values are delimited by | (pipe character).",
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"advanceWidthDelta": {
"default": 0,
"description": "Adjust advance width of this source font face.",
"type": "integer"
},
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"gameIndexFileName": {
"description": "Game index file search configuration, specified as key from gameIndexFiles above.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"minimum": 1,
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"advanceWidthDelta": {
"default": 0,
"description": "Adjust advance width of this source font face.",
"type": "integer"
},
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Define maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent among the given sources will be used. If string is given, ascent of the specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"compactLayout": {
"default": null,
"description": "Let each glyph have different height to save space. If set, overrides global config.",
"type": [
"boolean",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"lineHeight": {
"default": null,
"description": "Line height (ascent + descent + lien gap(external leading)) of the font. If null is given, the maximum line height among the given sources will be used. If string is given, line height of the specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"extendRange": {
"default": true,
"description": "Whether to extend the character coverage of this font. If false, then will only replace font if replace is true. If replace is false and this is true, then this entry will do nothing.",
"type": "boolean"
},
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"textureFormat": {
"default": "RGBA4444",
"description": "Use high-quality texture for text.",
"enum": [
"RGBA4444",
"RGBA8888"
],
"type": "string"
},
"textureHeight": {
"default": 1024,
"type": "integer"
},
"textureWidth": {
"default": 1024,
"type": "integer"
}
},
"required": [
"name",
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 8f8ff147948d43852b0ec5e460854fc4be1e499b | 2021-12-25T17:14:17 | StaticData/ExcelTransformConfig/exceltransformconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/exceltransformconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to transform cells",
"properties": {
"columnMap": {
"patternProperties": {
"^(?!#)": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"type": "object"
},
"description": {
"type": "string"
},
"ignoredCells": {
"items": {
"properties": {
"column": {
"type": "integer"
},
"forceLanguage": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id",
"column"
],
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pluralMap": {
"patternProperties": {
"^(?!#)": {
"items": {
"maxItems": 4,
"minItems": 2,
"type": [
"integer",
"null"
]
},
"type": "array"
}
},
"type": "object"
},
"replacementTemplates": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"rules": {
"items": {
"properties": {
"replaceTo": {
"type": "string"
},
"stringPattern": {
"type": "string"
},
"targetGroups": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"targetGroups",
"replaceTo"
],
"type": "object"
},
"type": "array"
},
"sourceLanguages": {
"items": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
},
"sourceReplacements": {
"items": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"targetGroups": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"items": {
"minItems": 1,
"type": [
"integer"
]
},
"type": [
"array",
"integer"
]
}
},
"type": "object"
},
"targetLanguage": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
}
},
"required": [
"name",
"targetLanguage",
"sourceLanguages",
"targetGroups",
"rules"
],
"title": "Excel String Transformation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 5e77bfec14827461bbd0dc24c0b46f8e9e2df15b | 2021-09-13T16:46:03 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"description": {
"type": "string"
},
"glyphGap": {
"default": 1,
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer",
"array"
]
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"minimum": 1,
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent will be used. If string is given, ascent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"descent": {
"default": null,
"description": "Descent of the font. If null is given, the maximum descent will be used. If string is given, descent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"extendRange": {
"default": true,
"description": "Whether to extend the character coverage of this font. If false, then will only replace font if replace is true. If replace is false and this is true, then this entry will do nothing.",
"type": "boolean"
},
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"textureHeight": {
"default": 1024,
"type": "integer"
},
"textureType": {
"default": "RGBA4444",
"description": "Use high-quality texture for text.",
"enum": [
"RGBA4444",
"RGBA8888"
],
"type": "string"
},
"textureWidth": {
"default": 1024,
"type": "integer"
}
},
"required": [
"name",
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 705e167ada77d72959894b24383e49959936f237 | 2021-09-20T17:59:48 | StaticData/ExcelTransformConfig/exceltransformconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/exceltransformconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to transform cells",
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"pluralMap": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"items": {
"maxItems": 4,
"minItems": 2,
"type": [
"integer",
"null"
]
},
"type": "array"
}
},
"type": "object"
},
"replacementTemplates": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"rules": {
"items": {
"properties": {
"replaceTo": {
"type": "string"
},
"stringPattern": {
"type": "string"
},
"targetGroups": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"targetGroups",
"replaceTo"
],
"type": "object"
},
"type": "array"
},
"sourceLanguages": {
"items": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
},
"sourceReplacements": {
"items": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"targetGroups": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"items": {
"minItems": 1,
"type": [
"integer"
]
},
"type": [
"array",
"integer"
]
}
},
"type": "object"
},
"targetLanguage": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
}
},
"required": [
"name",
"targetLanguage",
"sourceLanguages",
"targetGroups",
"rules"
],
"title": "Excel String Transformation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 8371d70e42c64cd082d90fc1ca102b687c9d3899 | 2021-09-14T16:39:51 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"compactLayout": {
"default": false,
"description": "Let each glyph have different height to save space.",
"type": "boolean"
},
"description": {
"type": "string"
},
"glyphGap": {
"default": 1,
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer",
"array"
]
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"minimum": 1,
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent among the given sources will be used. If string is given, ascent of the specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"compactLayout": {
"default": null,
"description": "Let each glyph have different height to save space. If set, overrides global config.",
"type": [
"boolean",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"lineHeight": {
"default": null,
"description": "Line height (ascent + descent + lien gap(external leading)) of the font. If null is given, the maximum line height among the given sources will be used. If string is given, line height of the specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"extendRange": {
"default": true,
"description": "Whether to extend the character coverage of this font. If false, then will only replace font if replace is true. If replace is false and this is true, then this entry will do nothing.",
"type": "boolean"
},
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"textureHeight": {
"default": 1024,
"type": "integer"
},
"textureType": {
"default": "RGBA4444",
"description": "Use high-quality texture for text.",
"enum": [
"RGBA4444",
"RGBA8888"
],
"type": "string"
},
"textureWidth": {
"default": 1024,
"type": "integer"
}
},
"required": [
"name",
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | d49d2b90437f0f23b013a0bb3b8327c423ee469e | 2021-09-11T07:40:30 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent will be used. If string is given, ascent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"descent": {
"default": null,
"description": "Descent of the font. If null is given, the maximum descent will be used. If string is given, descent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 29515124a525b2260857e70f5e3069c54baaef87 | 2021-09-18T22:00:02 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"compactLayout": {
"default": false,
"description": "Let each glyph have different height to save space.",
"type": "boolean"
},
"description": {
"type": "string"
},
"glyphGap": {
"default": 1,
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"offsetXModifier": {
"default": 0,
"type": "integer"
},
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer",
"array"
]
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"minimum": 1,
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent among the given sources will be used. If string is given, ascent of the specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"compactLayout": {
"default": null,
"description": "Let each glyph have different height to save space. If set, overrides global config.",
"type": [
"boolean",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"lineHeight": {
"default": null,
"description": "Line height (ascent + descent + lien gap(external leading)) of the font. If null is given, the maximum line height among the given sources will be used. If string is given, line height of the specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"extendRange": {
"default": true,
"description": "Whether to extend the character coverage of this font. If false, then will only replace font if replace is true. If replace is false and this is true, then this entry will do nothing.",
"type": "boolean"
},
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"textureHeight": {
"default": 1024,
"type": "integer"
},
"textureType": {
"default": "RGBA4444",
"description": "Use high-quality texture for text.",
"enum": [
"RGBA4444",
"RGBA8888"
],
"type": "string"
},
"textureWidth": {
"default": 1024,
"type": "integer"
}
},
"required": [
"name",
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 6095a94f80ae932576e326e84023721aab0f1bd0 | 2021-09-14T07:13:39 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"description": {
"type": "string"
},
"glyphGap": {
"default": 1,
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer",
"array"
]
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"minimum": 1,
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent among the given sources will be used. If string is given, ascent of the specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"lineHeight": {
"default": null,
"description": "Line height (ascent + descent + lien gap(external leading)) of the font. If null is given, the maximum line height among the given sources will be used. If string is given, line height of the specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"extendRange": {
"default": true,
"description": "Whether to extend the character coverage of this font. If false, then will only replace font if replace is true. If replace is false and this is true, then this entry will do nothing.",
"type": "boolean"
},
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"textureHeight": {
"default": 1024,
"type": "integer"
},
"textureType": {
"default": "RGBA4444",
"description": "Use high-quality texture for text.",
"enum": [
"RGBA4444",
"RGBA8888"
],
"type": "string"
},
"textureWidth": {
"default": 1024,
"type": "integer"
}
},
"required": [
"name",
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 5fe5b2f5da32350340ef4e6586298e527fc2946c | 2022-05-12T15:40:50 | StaticData/ExcelTransformConfig/exceltransformconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/exceltransformconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to transform cells",
"properties": {
"columnMap": {
"patternProperties": {
"^(?!#)": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"type": "object"
},
"description": {
"type": "string"
},
"ignoredCells": {
"items": {
"properties": {
"column": {
"type": "integer"
},
"forceLanguage": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": [
"string",
"null"
]
},
"forceString": {
"type": [
"string",
"null"
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"id",
"column"
],
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pluralMap": {
"patternProperties": {
"^(?!#)": {
"items": {
"maxItems": 4,
"minItems": 2,
"type": [
"integer",
"null"
]
},
"type": "array"
}
},
"type": "object"
},
"replacementTemplates": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"rules": {
"items": {
"properties": {
"replaceTo": {
"type": "string"
},
"stringPattern": {
"type": "string"
},
"targetGroups": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"targetGroups",
"replaceTo"
],
"type": "object"
},
"type": "array"
},
"sourceLanguages": {
"items": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1,
"type": "array"
},
"sourceReplacements": {
"items": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"targetGroups": {
"patternProperties": {
"[^#][A-Za-z0-9]+": {
"items": {
"minItems": 1,
"type": [
"integer"
]
},
"type": [
"array",
"integer"
]
}
},
"type": "object"
},
"targetLanguage": {
"enum": [
"Japanese",
"English",
"German",
"French",
"ChineseSimplified",
"ChineseTraditional",
"Korean"
],
"type": "string"
}
},
"required": [
"name",
"targetLanguage",
"sourceLanguages",
"targetGroups",
"rules"
],
"title": "Excel String Transformation Configuration",
"type": "object"
} | Apache-2.0 | en |
Soreepeong/XivAlexander | 3947927812a27d93908d3bf86b1c3233f01d1b9f | 2021-09-12T11:19:39 | StaticData/FontConfig/fontconfig.schema.json | 680 | 2024-05-28T01:04:08.063048Z | {
"$id": "https://xivalexander/fontconfig.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Describe how to generate fdt and tex files that will be used to replace the game's font.",
"properties": {
"description": {
"type": "string"
},
"glyphGap": {
"default": 1,
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"ranges": {
"default": {},
"description": "Defines sets of character ranges to be included (when specified).",
"patternProperties": {
"": {
"description": "Defines a set of character ranges.",
"patternProperties": {
"": {
"description": "Defines a character or an endpoint inclusive range of characters. You may use U+#### or 0x#### notation as string.",
"items": {
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer"
]
},
"maxItems": 2,
"minItems": 1,
"pattern": "^(?:(?:[Uu]\\+|0x)[0-9A-Fa-f]+|[0-9]+)",
"type": [
"string",
"integer",
"array"
]
}
},
"type": "object"
}
},
"type": "object"
},
"revision": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"sources": {
"description": "Defines font to be used when generating fdt and tex files.",
"patternProperties": {
"^dwrite:": {
"properties": {
"familyName": {
"description": "Name of font installed on your system.",
"type": "string"
},
"height": {
"description": "Height of font, in pixels.",
"minimumExclusive": 0,
"type": "number"
},
"renderMode": {
"default": "DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC",
"description": "DirectWrite render mode. Refer to https://docs.microsoft.com/en-us/windows/win32/api/dwrite/ne-dwrite-dwrite_rendering_mode",
"enum": [
"DWRITE_RENDERING_MODE_ALIASED",
"DWRITE_RENDERING_MODE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL",
"DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC",
"DWRITE_RENDERING_MODE_OUTLINE",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC",
"DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL",
"DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC"
],
"type": "string"
},
"stretch": {
"description": "Stretch of the font.",
"enum": [
"DWRITE_FONT_STRETCH_ULTRA_CONDENSED",
"DWRITE_FONT_STRETCH_EXTRA_CONDENSED",
"DWRITE_FONT_STRETCH_CONDENSED",
"DWRITE_FONT_STRETCH_SEMI_CONDENSED",
"DWRITE_FONT_STRETCH_NORMAL",
"DWRITE_FONT_STRETCH_MEDIUM",
"DWRITE_FONT_STRETCH_SEMI_EXPANDED",
"DWRITE_FONT_STRETCH_EXPANDED",
"DWRITE_FONT_STRETCH_EXTRA_EXPANDED",
"DWRITE_FONT_STRETCH_ULTRA_EXPANDED"
],
"type": "string"
},
"style": {
"default": "DWRITE_FONT_STYLE_NORMAL",
"description": "Style of the font.",
"enum": [
"DWRITE_FONT_STYLE_NORMAL",
"DWRITE_FONT_STYLE_OBLIQUE",
"DWRITE_FONT_STYLE_ITALIC"
],
"type": "string"
},
"weight": {
"default": 400,
"description": "Weight of font, between 1 and 1000.",
"enum": [
"thin",
"extralight",
"ultralight",
"light",
"semilight",
"normal",
"regular",
"medium",
"semibold",
"demibold",
"bold",
"extrabold",
"ultrabold",
"heavy",
"black",
"extrablack",
"ultrablack"
],
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"string"
]
}
},
"required": [
"familyName",
"height"
],
"type": "object"
},
"^game:": {
"properties": {
"fdtPath": {
"description": "Inner path to fdt file associated with this font.",
"type": "string"
},
"indexFile": {
"description": "Path to index file. If unspecified or null, uses the current installation's 000000.sqpack.index",
"type": [
"string",
"null"
]
},
"textureCount": {
"description": "Number of tex files associated with this font.",
"minimum": 1,
"type": "integer"
},
"texturePath": {
"description": "Pattern of inner path to tex files associated with this font. Use {} as a placeholder for a number between 1 and textureCount.",
"type": "string"
}
},
"required": [
"fdtPath",
"texturePath",
"textureCount"
],
"type": "object"
},
"^gdi:": {
"properties": {
"charSet": {},
"clipPrecision": {},
"escapement": {},
"faceName": {},
"height": {},
"italic": {},
"orientation": {},
"outPrecision": {},
"pitchAndFamily": {},
"quality": {},
"strikeOut": {},
"underline": {},
"weight": {},
"width": {}
},
"required": [
"faceName",
"height"
],
"type": "object"
}
},
"type": "object"
},
"targets": {
"description": "Defines maps of the relationships of tex and fdt files to be generated. Use {} as a placeholder for texture index in filenames(keys).",
"patternProperties": {
"": {
"description": "Defines fonts to be stored in this set of tex files. Specify filename including .fdt extension as keys.",
"patternProperties": {
"": {
"description": "Defines a font.",
"properties": {
"alignToBaseline": {
"default": true,
"type": "boolean"
},
"ascent": {
"default": null,
"description": "Ascent of the font. If null is given, the maximum ascent will be used. If string is given, ascent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"charactersToKernAcrossFonts": {
"default": " ",
"type": "string"
},
"descent": {
"default": null,
"description": "Descent of the font. If null is given, the maximum descent will be used. If string is given, descent of specified font from sources will be used.",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"string",
"null"
]
},
"globalOffsetY": {
"default": 0,
"maximum": 255,
"type": "integer"
},
"height": {
"minimumExclusive": 0,
"type": "number"
},
"maxGlobalOffsetX": {
"default": 4,
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"sources": {
"items": {
"properties": {
"extendRange": {
"default": true,
"description": "Whether to extend the character coverage of this font. If false, then will only replace font if replace is true. If replace is false and this is true, then this entry will do nothing.",
"type": "boolean"
},
"name": {
"type": "string"
},
"ranges": {
"default": null,
"description": "If unspecified or null, every characters will be applied.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"replace": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"height",
"sources"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"textureHeight": {
"default": 1024,
"type": "integer"
},
"textureWidth": {
"default": 1024,
"type": "integer"
}
},
"required": [
"name",
"sources",
"targets"
],
"title": "Font Generation Configuration",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 12b2071bbd26c7a96d294dc9c2b0fc7da6a65818 | 2022-09-06T14:05:42 | projects/emissary-ingress/emissary/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"adminService": {
"annotations": {},
"create": true,
"loadBalancerIP": null,
"loadBalancerSourceRanges": null,
"nodePort": null,
"port": 8877,
"snapshotPort": 8005,
"type": "ClusterIP"
},
"affinity": {},
"barePod": false,
"deploymentStrategy": {
"type": "RollingUpdate"
},
"dnsPolicy": "ClusterFirst",
"docker": {},
"env": {},
"hostNetwork": false,
"image": {
"digest": "sha256:735898bc7a555ce0d842cf28eefaa9824eb5f28396e9eb229ae05c0d601c4e3e",
"pullPolicy": "IfNotPresent",
"repository": "emissary-ingress/emissary",
"tag": null
},
"imagePullSecrets": [],
"ingressClassResource": {
"controllerValue": "getambassador.io/ingress-controller",
"default": false,
"enabled": true,
"name": "ambassador"
},
"livenessProbe": {
"failureThreshold": 3,
"initialDelaySeconds": 30,
"periodSeconds": 3
},
"nodeSelector": {},
"podDisruptionBudget": {},
"rbac": {
"create": true,
"nameOverride": null,
"podSecurityPolicies": []
},
"readinessProbe": {
"failureThreshold": 3,
"initialDelaySeconds": 30,
"periodSeconds": 3
},
"replicaCount": 2,
"resources": {
"limits": {
"cpu": "1000m",
"memory": "600Mi"
},
"requests": {
"cpu": "200m",
"memory": "300Mi"
}
},
"service": {
"annotations": {},
"externalIPs": [],
"externalTrafficPolicy": null,
"nameOverride": null,
"ports": [
{
"name": "http",
"port": 80,
"targetPort": 8080
},
{
"name": "https",
"port": 443,
"targetPort": 8443
}
],
"portsRaw": "",
"sessionAffinity": null,
"sessionAffinityConfig": null,
"type": "LoadBalancer"
},
"serviceAccount": {
"create": true,
"extra": "",
"name": null
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"volumeMounts": [],
"volumes": []
}
],
"properties": {
"adminService": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"loadBalancerIP": null,
"loadBalancerSourceRanges": null,
"nodePort": null,
"port": 8877,
"snapshotPort": 8005,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"loadBalancerIP": {
"default": null,
"examples": [
null
],
"title": "The loadBalancerIP Schema",
"type": "null"
},
"loadBalancerSourceRanges": {
"default": null,
"examples": [
null
],
"title": "The loadBalancerSourceRanges Schema",
"type": "null"
},
"nodePort": {
"default": null,
"examples": [
null
],
"title": "The nodePort Schema",
"type": "null"
},
"port": {
"default": 8877,
"examples": [
8877
],
"title": "The port Schema",
"type": "integer"
},
"snapshotPort": {
"default": 8005,
"examples": [
8005
],
"title": "The snapshotPort Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"create",
"type",
"port"
],
"title": "The adminService Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"daemonSet": {
"default": false,
"examples": [
false
],
"title": "The daemonSet Schema",
"type": "boolean"
},
"deploymentStrategy": {
"default": {},
"examples": [
{
"type": "RollingUpdate"
}
],
"properties": {
"type": {
"default": "RollingUpdate",
"examples": [
"RollingUpdate"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type"
],
"title": "The deploymentStrategy Schema",
"type": "object"
},
"dnsPolicy": {
"default": "ClusterFirst",
"examples": [
"ClusterFirst"
],
"title": "The dnsPolicy Schema",
"type": "string"
},
"docker": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The docker Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The env Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:735898bc7a555ce0d842cf28eefaa9824eb5f28396e9eb229ae05c0d601c4e3e",
"pullPolicy": "IfNotPresent",
"repository": "emissary-ingress/emissary",
"tag": null
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:735898bc7a555ce0d842cf28eefaa9824eb5f28396e9eb229ae05c0d601c4e3e"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "emissary-ingress/emissary",
"examples": [
"emissary-ingress/emissary"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": null,
"examples": [
null
],
"title": "The tag Schema",
"type": "null"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"ingressClassResource": {
"default": {},
"examples": [
{
"controllerValue": "getambassador.io/ingress-controller",
"default": false,
"enabled": true,
"name": "ambassador"
}
],
"properties": {
"controllerValue": {
"default": "getambassador.io/ingress-controller",
"examples": [
"getambassador.io/ingress-controller"
],
"title": "The controllerValue Schema",
"type": "string"
},
"default": {
"default": false,
"examples": [
false
],
"title": "The default Schema",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"name": {
"default": "ambassador",
"examples": [
"ambassador"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"enabled",
"name"
],
"title": "The ingressClassResource Schema",
"type": "object"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"initialDelaySeconds": 30,
"periodSeconds": 3
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"initialDelaySeconds": {
"default": 30,
"examples": [
30
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 3,
"examples": [
3
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [
"initialDelaySeconds",
"periodSeconds",
"failureThreshold"
],
"title": "The livenessProbe Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"nameOverride": null,
"podSecurityPolicies": []
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"nameOverride": {
"default": null,
"examples": [
null
],
"title": "The nameOverride Schema",
"type": "null"
},
"podSecurityPolicies": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The podSecurityPolicies Schema",
"type": "array"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"initialDelaySeconds": 30,
"periodSeconds": 3
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"initialDelaySeconds": {
"default": 30,
"examples": [
30
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 3,
"examples": [
3
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [
"initialDelaySeconds",
"periodSeconds",
"failureThreshold"
],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "1000m",
"memory": "600Mi"
},
"requests": {
"cpu": "200m",
"memory": "300Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "1000m",
"memory": "600Mi"
}
],
"properties": {
"cpu": {
"default": "1000m",
"examples": [
"1000m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "600Mi",
"examples": [
"600Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "200m",
"memory": "300Mi"
}
],
"properties": {
"cpu": {
"default": "200m",
"examples": [
"200m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "300Mi",
"examples": [
"300Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"externalIPs": [],
"externalTrafficPolicy": null,
"nameOverride": null,
"ports": [
{
"name": "http",
"port": 80,
"targetPort": 8080
},
{
"name": "https",
"port": 443,
"targetPort": 8443
}
],
"portsRaw": "",
"sessionAffinity": null,
"sessionAffinityConfig": null,
"type": "LoadBalancer"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"externalIPs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The externalIPs Schema",
"type": "array"
},
"externalTrafficPolicy": {
"default": null,
"examples": [
null
],
"title": "The externalTrafficPolicy Schema",
"type": "null"
},
"nameOverride": {
"default": null,
"examples": [
null
],
"title": "The nameOverride Schema",
"type": "null"
},
"ports": {
"default": [],
"examples": [
[
{
"name": "http",
"port": 80,
"targetPort": 8080
},
{
"name": "https",
"port": 443,
"targetPort": 8443
}
]
],
"items": {
"examples": [
{
"name": "http",
"port": 80,
"targetPort": 8080
},
{
"name": "https",
"port": 443,
"targetPort": 8443
}
],
"properties": {
"name": {
"examples": [
"http",
"https"
],
"title": "The name Schema",
"type": "string"
},
"port": {
"examples": [
80,
443
],
"title": "The port Schema",
"type": "integer"
},
"targetPort": {
"examples": [
8080,
8443
],
"title": "The targetPort Schema",
"type": "integer"
}
},
"required": [
"name",
"port",
"targetPort"
],
"title": "A Schema",
"type": "object"
},
"title": "The ports Schema",
"type": "array"
},
"portsRaw": {
"default": "",
"examples": [
""
],
"title": "The portsRaw Schema",
"type": "string"
},
"sessionAffinity": {
"default": null,
"examples": [
null
],
"title": "The sessionAffinity Schema",
"type": "null"
},
"sessionAffinityConfig": {
"default": null,
"examples": [
null
],
"title": "The sessionAffinityConfig Schema",
"type": "null"
},
"type": {
"default": "",
"examples": [
"LoadBalancer"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"ports"
],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"create": true,
"extra": "",
"name": null
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"extra": {
"default": "",
"examples": [
""
],
"title": "The extra Schema",
"type": "string"
},
"name": {
"default": null,
"examples": [
null
],
"title": "The name Schema",
"type": "null"
}
},
"required": [
"create"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"sourceRegistry": {
"default": "public.ecr.aws/eks-anywhere",
"examples": [
"public.ecr.aws/eks-anywhere"
],
"title": "The sourceRegistry Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"volumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The volumeMounts Schema",
"type": "array"
},
"volumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The volumes Schema",
"type": "array"
}
},
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 64cffc5a869c8189d488160d803e6793edd792b2 | 2024-01-18T18:42:35 | projects/kubernetes-sigs/metrics-server/1-29/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "Annotations to add to the APIService",
"type": "object"
},
"caBundle": {
"default": "",
"examples": [
""
],
"title": "PEM encoded CA bundle for TLS verification",
"type": "string"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"insecureSkipTLSVerify": {
"default": true,
"examples": [
true
],
"title": "Specifies whether to skip TLS verification",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"commonLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The commonLabels Schema",
"type": "object"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"securityContext": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 10250,
"examples": [
10250
],
"title": "The containerPort Schema",
"type": "integer"
},
"default": {},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"drop": {
"default": [
"ALL"
],
"examples": [
[]
],
"items": {},
"title": "The drop Schema",
"type": "array"
}
},
"required": [],
"title": "The seccompProfile Schema",
"type": "object"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
},
"seccompProfile": {
"default": {},
"examples": [
{}
],
"properties": {
"type": {
"default": "RuntimeDefault",
"examples": [
"RuntimeDefault"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The seccompProfile Schema",
"type": "object"
}
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"required": [],
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"schedulerName": {
"default": "",
"examples": [],
"title": "The schedulerName Schema",
"type": "string"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The metricRelabelings Schema",
"type": "array"
},
"relabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The relabelings Schema",
"type": "array"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"title": "The securityContext Schema",
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"type": "object",
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
},
"secrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The list of secrets mountable by this service account",
"type": "array"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 91ce512a7627aaa47e1314183e0dc6ef3073db66 | 2023-11-30T23:34:47 | projects/kubernetes-sigs/metrics-server/1-29/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 4443,
"examples": [
4443
],
"title": "The containerPort Schema",
"type": "integer"
},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | c78b6559612abf20e8474b3b2ff6bbfa6d273756 | 2022-07-29T18:04:24 | projects/goharbor/harbor/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"caSecretName": "",
"chartmuseum": {
"absoluteUrl": false,
"affinity": {},
"automountServiceAccountToken": false,
"enabled": false,
"image": {
"digest": {
"{\"harbor/harbor-chartmuseum\"=>nil}": null
},
"repository": "harbor/harbor-chartmuseum"
},
"indexLimit": 0,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"core": {
"affinity": {},
"artifactPullAsyncFlushDuration": null,
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-core\"=>nil}": null
},
"repository": "harbor/harbor-core"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"secretName": "",
"serviceAccountName": "",
"startupProbe": {
"enabled": true,
"initialDelaySeconds": 10
},
"tolerations": [],
"xsrfKey": ""
},
"database": {
"external": {
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-db\"=>nil}": null
},
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
},
"maxIdleConns": 100,
"maxOpenConns": 900,
"podAnnotations": {},
"type": "internal"
},
"enableMigrateHelmHook": false,
"exporter": {
"affinity": {},
"automountServiceAccountToken": false,
"cacheCleanInterval": 14400,
"cacheDuration": 23,
"image": {
"digest": {
"{\"harbor/harbor-exporter\"=>nil}": null
},
"repository": "harbor/harbor-exporter"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"expose": {
"clusterIP": {
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
},
"ingress": {
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
},
"loadBalancer": {
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
},
"nodePort": {
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
},
"tls": {
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
},
"type": "nodePort"
},
"externalURL": "https://127.0.0.1:30003",
"harborAdminPassword": "Harbor12345",
"imagePullPolicy": "IfNotPresent",
"imagePullSecrets": null,
"internalTLS": {
"certSource": "auto",
"chartmuseum": {
"crt": "",
"key": "",
"secretName": ""
},
"core": {
"crt": "",
"key": "",
"secretName": ""
},
"enabled": true,
"jobservice": {
"crt": "",
"key": "",
"secretName": ""
},
"portal": {
"crt": "",
"key": "",
"secretName": ""
},
"registry": {
"crt": "",
"key": "",
"secretName": ""
},
"trivy": {
"crt": "",
"key": "",
"secretName": ""
},
"trustCa": ""
},
"ipFamily": {
"ipv4": {
"enabled": true
},
"ipv6": {
"enabled": true
}
},
"jobservice": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-jobservice\"=>nil}": null
},
"repository": "harbor/harbor-jobservice"
},
"jobLoggers": [
"file"
],
"loggerSweeperDuration": 14,
"maxJobWorkers": 10,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": []
},
"logLevel": "info",
"metrics": {
"core": {
"path": "/metrics",
"port": 8001
},
"enabled": false,
"exporter": {
"path": "/metrics",
"port": 8001
},
"jobservice": {
"path": "/metrics",
"port": 8001
},
"registry": {
"path": "/metrics",
"port": 8001
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
},
"nginx": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-nginx\"=>nil}": null
},
"repository": "harbor/harbor-nginx"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"notary": {
"enabled": false,
"secretName": "",
"server": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-notary-server\"=>nil}": null
},
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
},
"signer": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-notary-signer\"=>nil}": null
},
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
},
"persistence": {
"enabled": true,
"imageChartStorage": {
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
},
"persistentVolumeClaim": {
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
},
"resourcePolicy": "keep"
},
"portal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-portal\"=>nil}": null
},
"repository": "harbor/harbor-portal"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"proxy": {
"components": [
"core",
"jobservice",
"trivy"
],
"httpProxy": null,
"httpsProxy": null,
"noProxy": "127.0.0.1,localhost,.local,.internal"
},
"redis": {
"external": {
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-redis\"=>nil}": null
},
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
},
"podAnnotations": {},
"type": "internal"
},
"registry": {
"affinity": {},
"automountServiceAccountToken": false,
"controller": {
"image": {
"digest": {
"{\"harbor/harbor-registryctl\"=>nil}": null
},
"repository": "harbor/harbor-registryctl"
}
},
"credentials": {
"password": "harbor_registry_password",
"username": "harbor_registry_user"
},
"middleware": {
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"registry": {
"image": {
"digest": {
"{\"harbor/harbor-registry\"=>nil}": null
},
"repository": "harbor/harbor-registry"
}
},
"relativeurls": false,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": [],
"upload_purging": {
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
},
"secretKey": "",
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"trace": {
"enabled": false,
"jaeger": {
"endpoint": "http://hostname:14268/api/traces"
},
"otel": {
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
},
"provider": "jaeger",
"sample_rate": 1
},
"trivy": {
"affinity": {},
"automountServiceAccountToken": false,
"debugMode": false,
"enabled": true,
"gitHubToken": "",
"ignoreUnfixed": false,
"image": {
"digest": {
"{\"harbor/harbor-trivy\"=>nil}": null
},
"repository": "harbor/harbor-trivy"
},
"insecure": false,
"nodeSelector": {},
"offlineScan": false,
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"resources": {
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
},
"serviceAccountName": "",
"severity": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"skipUpdate": false,
"timeout": "5m0s",
"tolerations": [],
"vulnType": "os,library"
},
"updateStrategy": {
"type": "Recreate"
}
}
],
"properties": {
"caSecretName": {
"default": "",
"examples": [
""
],
"title": "The caSecretName Schema",
"type": "string"
},
"chartmuseum": {
"default": {},
"examples": [
{
"absoluteUrl": false,
"affinity": {},
"automountServiceAccountToken": false,
"enabled": false,
"image": {
"digest": {
"{\"harbor/harbor-chartmuseum\"=>nil}": null
},
"repository": "harbor/harbor-chartmuseum"
},
"indexLimit": 0,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"absoluteUrl": {
"default": false,
"examples": [
false
],
"title": "The absoluteUrl Schema",
"type": "boolean"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-chartmuseum\"=>nil}": null
},
"repository": "harbor/harbor-chartmuseum"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-chartmuseum\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-chartmuseum\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-chartmuseum\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-chartmuseum\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-chartmuseum"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"indexLimit": {
"default": 0,
"examples": [
0
],
"title": "The indexLimit Schema",
"type": "integer"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 0,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"enabled",
"serviceAccountName",
"automountServiceAccountToken",
"absoluteUrl",
"image",
"replicas",
"revisionHistoryLimit",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName",
"indexLimit"
],
"title": "The chartmuseum Schema",
"type": "object"
},
"core": {
"default": {},
"examples": [
{
"affinity": {},
"artifactPullAsyncFlushDuration": null,
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-core\"=>nil}": null
},
"repository": "harbor/harbor-core"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"secretName": "",
"serviceAccountName": "",
"startupProbe": {
"enabled": true,
"initialDelaySeconds": 10
},
"tolerations": [],
"xsrfKey": ""
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"artifactPullAsyncFlushDuration": {
"default": null,
"examples": [
null
],
"title": "The artifactPullAsyncFlushDuration Schema",
"type": "null"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-core\"=>nil}": null
},
"repository": "harbor/harbor-core"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-core\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-core\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-core\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-core\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-core"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 0,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"startupProbe": {
"default": {},
"examples": [
{
"enabled": true,
"initialDelaySeconds": 10
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
10
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
}
},
"required": [
"enabled",
"initialDelaySeconds"
],
"title": "The startupProbe Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"xsrfKey": {
"default": "",
"examples": [
""
],
"title": "The xsrfKey Schema",
"type": "string"
}
},
"required": [
"image",
"serviceAccountName",
"automountServiceAccountToken",
"replicas",
"revisionHistoryLimit",
"startupProbe",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"secret",
"secretName",
"xsrfKey",
"priorityClassName",
"artifactPullAsyncFlushDuration"
],
"title": "The core Schema",
"type": "object"
},
"database": {
"default": {},
"examples": [
{
"external": {
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-db\"=>nil}": null
},
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
},
"maxIdleConns": 100,
"maxOpenConns": 900,
"podAnnotations": {},
"type": "internal"
}
],
"properties": {
"external": {
"default": {},
"examples": [
{
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
}
],
"properties": {
"coreDatabase": {
"default": "",
"examples": [
"registry"
],
"title": "The coreDatabase Schema",
"type": "string"
},
"host": {
"default": "",
"examples": [
"192.168.0.1"
],
"title": "The host Schema",
"type": "string"
},
"notaryServerDatabase": {
"default": "",
"examples": [
"notary_server"
],
"title": "The notaryServerDatabase Schema",
"type": "string"
},
"notarySignerDatabase": {
"default": "",
"examples": [
"notary_signer"
],
"title": "The notarySignerDatabase Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
"password"
],
"title": "The password Schema",
"type": "string"
},
"port": {
"default": "",
"examples": [
"5432"
],
"title": "The port Schema",
"type": "string"
},
"sslmode": {
"default": "",
"examples": [
"disable"
],
"title": "The sslmode Schema",
"type": "string"
},
"username": {
"default": "",
"examples": [
"user"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"host",
"port",
"username",
"password",
"coreDatabase",
"notaryServerDatabase",
"notarySignerDatabase",
"sslmode"
],
"title": "The external Schema",
"type": "object"
},
"internal": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-db\"=>nil}": null
},
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-db\"=>nil}": null
},
"repository": "harbor/harbor-db"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-db\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-db\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-db\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-db\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-db"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"initContainer": {
"default": {},
"examples": [
{
"migrator": {},
"permissions": {}
}
],
"properties": {
"migrator": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The migrator Schema",
"type": "object"
},
"permissions": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The permissions Schema",
"type": "object"
}
},
"required": [
"migrator",
"permissions"
],
"title": "The initContainer Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"password": {
"default": "",
"examples": [
"changeit"
],
"title": "The password Schema",
"type": "string"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"shmSizeLimit": {
"default": "",
"examples": [
"512Mi"
],
"title": "The shmSizeLimit Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"image",
"password",
"shmSizeLimit",
"nodeSelector",
"tolerations",
"affinity",
"priorityClassName",
"initContainer"
],
"title": "The internal Schema",
"type": "object"
},
"maxIdleConns": {
"default": 0,
"examples": [
100
],
"title": "The maxIdleConns Schema",
"type": "integer"
},
"maxOpenConns": {
"default": 0,
"examples": [
900
],
"title": "The maxOpenConns Schema",
"type": "integer"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"type": {
"default": "",
"examples": [
"internal"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"internal",
"external",
"maxIdleConns",
"maxOpenConns",
"podAnnotations"
],
"title": "The database Schema",
"type": "object"
},
"enableMigrateHelmHook": {
"default": false,
"examples": [
false
],
"title": "The enableMigrateHelmHook Schema",
"type": "boolean"
},
"exporter": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"cacheCleanInterval": 14400,
"cacheDuration": 23,
"image": {
"digest": {
"{\"harbor/harbor-exporter\"=>nil}": null
},
"repository": "harbor/harbor-exporter"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"cacheCleanInterval": {
"default": 0,
"examples": [
14400
],
"title": "The cacheCleanInterval Schema",
"type": "integer"
},
"cacheDuration": {
"default": 0,
"examples": [
23
],
"title": "The cacheDuration Schema",
"type": "integer"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-exporter\"=>nil}": null
},
"repository": "harbor/harbor-exporter"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-exporter\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-exporter\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-exporter\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-exporter\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-exporter"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 0,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"replicas",
"revisionHistoryLimit",
"podAnnotations",
"serviceAccountName",
"automountServiceAccountToken",
"image",
"nodeSelector",
"tolerations",
"affinity",
"cacheDuration",
"cacheCleanInterval",
"priorityClassName"
],
"title": "The exporter Schema",
"type": "object"
},
"expose": {
"default": {},
"examples": [
{
"clusterIP": {
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
},
"ingress": {
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
},
"loadBalancer": {
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
},
"nodePort": {
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
},
"tls": {
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
},
"type": "nodePort"
}
],
"properties": {
"clusterIP": {
"default": {},
"examples": [
{
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"name": {
"default": "",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"default": {},
"examples": [
{
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
],
"properties": {
"httpPort": {
"default": 0,
"examples": [
80
],
"title": "The httpPort Schema",
"type": "integer"
},
"httpsPort": {
"default": 0,
"examples": [
443
],
"title": "The httpsPort Schema",
"type": "integer"
},
"notaryPort": {
"default": 0,
"examples": [
4443
],
"title": "The notaryPort Schema",
"type": "integer"
}
},
"required": [
"httpPort",
"httpsPort",
"notaryPort"
],
"title": "The ports Schema",
"type": "object"
}
},
"required": [
"name",
"annotations",
"ports"
],
"title": "The clusterIP Schema",
"type": "object"
},
"ingress": {
"default": {},
"examples": [
{
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
}
],
"properties": {
"ingress.kubernetes.io/proxy-body-size": {
"default": "",
"examples": [
"0"
],
"title": "The ingress.kubernetes.io/proxy-body-size Schema",
"type": "string"
},
"ingress.kubernetes.io/ssl-redirect": {
"default": "",
"examples": [
"true"
],
"title": "The ingress.kubernetes.io/ssl-redirect Schema",
"type": "string"
},
"nginx.ingress.kubernetes.io/proxy-body-size": {
"default": "",
"examples": [
"0"
],
"title": "The nginx.ingress.kubernetes.io/proxy-body-size Schema",
"type": "string"
},
"nginx.ingress.kubernetes.io/ssl-redirect": {
"default": "",
"examples": [
"true"
],
"title": "The nginx.ingress.kubernetes.io/ssl-redirect Schema",
"type": "string"
}
},
"required": [
"ingress.kubernetes.io/ssl-redirect",
"ingress.kubernetes.io/proxy-body-size",
"nginx.ingress.kubernetes.io/ssl-redirect",
"nginx.ingress.kubernetes.io/proxy-body-size"
],
"title": "The annotations Schema",
"type": "object"
},
"className": {
"default": "",
"examples": [
""
],
"title": "The className Schema",
"type": "string"
},
"controller": {
"default": "",
"examples": [
"default"
],
"title": "The controller Schema",
"type": "string"
},
"harbor": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
}
},
"required": [
"annotations",
"labels"
],
"title": "The harbor Schema",
"type": "object"
},
"hosts": {
"default": {},
"examples": [
{
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
}
],
"properties": {
"core": {
"default": "",
"examples": [
"core.harbor.domain"
],
"title": "The core Schema",
"type": "string"
},
"notary": {
"default": "",
"examples": [
"notary.harbor.domain"
],
"title": "The notary Schema",
"type": "string"
}
},
"required": [
"core",
"notary"
],
"title": "The hosts Schema",
"type": "object"
},
"kubeVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeVersionOverride Schema",
"type": "string"
},
"notary": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
}
},
"required": [
"annotations",
"labels"
],
"title": "The notary Schema",
"type": "object"
}
},
"required": [
"hosts",
"controller",
"kubeVersionOverride",
"className",
"annotations",
"notary",
"harbor"
],
"title": "The ingress Schema",
"type": "object"
},
"loadBalancer": {
"default": {},
"examples": [
{
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
}
],
"properties": {
"IP": {
"default": "",
"examples": [
""
],
"title": "The IP Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"name": {
"default": "",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"default": {},
"examples": [
{
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
],
"properties": {
"httpPort": {
"default": 0,
"examples": [
80
],
"title": "The httpPort Schema",
"type": "integer"
},
"httpsPort": {
"default": 0,
"examples": [
443
],
"title": "The httpsPort Schema",
"type": "integer"
},
"notaryPort": {
"default": 0,
"examples": [
4443
],
"title": "The notaryPort Schema",
"type": "integer"
}
},
"required": [
"httpPort",
"httpsPort",
"notaryPort"
],
"title": "The ports Schema",
"type": "object"
},
"sourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The sourceRanges Schema",
"type": "array"
}
},
"required": [
"name",
"IP",
"ports",
"annotations",
"sourceRanges"
],
"title": "The loadBalancer Schema",
"type": "object"
},
"nodePort": {
"default": {},
"examples": [
{
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
}
],
"properties": {
"name": {
"default": "",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"default": {},
"examples": [
{
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
],
"properties": {
"http": {
"default": {},
"examples": [
{
"nodePort": 30002,
"port": 80
}
],
"properties": {
"nodePort": {
"default": 0,
"examples": [
30002
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
80
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"port",
"nodePort"
],
"title": "The http Schema",
"type": "object"
},
"https": {
"default": {},
"examples": [
{
"nodePort": 30003,
"port": 443
}
],
"properties": {
"nodePort": {
"default": 0,
"examples": [
30003
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"port",
"nodePort"
],
"title": "The https Schema",
"type": "object"
},
"notary": {
"default": {},
"examples": [
{
"nodePort": 30004,
"port": 4443
}
],
"properties": {
"nodePort": {
"default": 0,
"examples": [
30004
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
4443
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"port",
"nodePort"
],
"title": "The notary Schema",
"type": "object"
}
},
"required": [
"http",
"https",
"notary"
],
"title": "The ports Schema",
"type": "object"
}
},
"required": [
"name",
"ports"
],
"title": "The nodePort Schema",
"type": "object"
},
"tls": {
"default": {},
"examples": [
{
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
}
],
"properties": {
"auto": {
"default": {},
"examples": [
{
"commonName": ""
}
],
"properties": {
"commonName": {
"default": "",
"examples": [
""
],
"title": "The commonName Schema",
"type": "string"
}
},
"required": [
"commonName"
],
"title": "The auto Schema",
"type": "object"
},
"certSource": {
"default": "",
"examples": [
"secret"
],
"title": "The certSource Schema",
"type": "string"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"secret": {
"default": {},
"examples": [
{
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
],
"properties": {
"notarySecretName": {
"default": "",
"examples": [
""
],
"title": "The notarySecretName Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
"harbor-tls-secret"
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"notarySecretName"
],
"title": "The secret Schema",
"type": "object"
}
},
"required": [
"enabled",
"certSource",
"auto",
"secret"
],
"title": "The tls Schema",
"type": "object"
},
"type": {
"default": "",
"examples": [
"nodePort"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"tls",
"ingress",
"clusterIP",
"nodePort",
"loadBalancer"
],
"title": "The expose Schema",
"type": "object"
},
"externalURL": {
"default": "",
"examples": [
"https://127.0.0.1:30003"
],
"title": "The externalURL Schema",
"type": "string"
},
"harborAdminPassword": {
"default": "",
"examples": [
"Harbor12345"
],
"title": "The harborAdminPassword Schema",
"type": "string"
},
"imagePullPolicy": {
"default": "",
"examples": [
"IfNotPresent"
],
"title": "The imagePullPolicy Schema",
"type": "string"
},
"imagePullSecrets": {
"default": null,
"examples": [
null
],
"title": "The imagePullSecrets Schema",
"type": "null"
},
"internalTLS": {
"default": {},
"examples": [
{
"certSource": "auto",
"chartmuseum": {
"crt": "",
"key": "",
"secretName": ""
},
"core": {
"crt": "",
"key": "",
"secretName": ""
},
"enabled": true,
"jobservice": {
"crt": "",
"key": "",
"secretName": ""
},
"portal": {
"crt": "",
"key": "",
"secretName": ""
},
"registry": {
"crt": "",
"key": "",
"secretName": ""
},
"trivy": {
"crt": "",
"key": "",
"secretName": ""
},
"trustCa": ""
}
],
"properties": {
"certSource": {
"default": "",
"examples": [
"auto"
],
"title": "The certSource Schema",
"type": "string"
},
"chartmuseum": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The chartmuseum Schema",
"type": "object"
},
"core": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The core Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"jobservice": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The jobservice Schema",
"type": "object"
},
"portal": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The portal Schema",
"type": "object"
},
"registry": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The registry Schema",
"type": "object"
},
"trivy": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The trivy Schema",
"type": "object"
},
"trustCa": {
"default": "",
"examples": [
""
],
"title": "The trustCa Schema",
"type": "string"
}
},
"required": [
"enabled",
"certSource",
"trustCa",
"core",
"jobservice",
"registry",
"portal",
"chartmuseum",
"trivy"
],
"title": "The internalTLS Schema",
"type": "object"
},
"ipFamily": {
"default": {},
"examples": [
{
"ipv4": {
"enabled": true
},
"ipv6": {
"enabled": true
}
}
],
"properties": {
"ipv4": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The ipv4 Schema",
"type": "object"
},
"ipv6": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The ipv6 Schema",
"type": "object"
}
},
"required": [
"ipv6",
"ipv4"
],
"title": "The ipFamily Schema",
"type": "object"
},
"jobservice": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-jobservice\"=>nil}": null
},
"repository": "harbor/harbor-jobservice"
},
"jobLoggers": [
"file"
],
"loggerSweeperDuration": 14,
"maxJobWorkers": 10,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-jobservice\"=>nil}": null
},
"repository": "harbor/harbor-jobservice"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-jobservice\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-jobservice\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-jobservice\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-jobservice\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-jobservice"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"jobLoggers": {
"default": [],
"examples": [
[
"file"
]
],
"items": {
"default": "",
"examples": [
"file"
],
"title": "A Schema",
"type": "string"
},
"title": "The jobLoggers Schema",
"type": "array"
},
"loggerSweeperDuration": {
"default": 0,
"examples": [
14
],
"title": "The loggerSweeperDuration Schema",
"type": "integer"
},
"maxJobWorkers": {
"default": 0,
"examples": [
10
],
"title": "The maxJobWorkers Schema",
"type": "integer"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 0,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"replicas",
"revisionHistoryLimit",
"serviceAccountName",
"automountServiceAccountToken",
"maxJobWorkers",
"jobLoggers",
"loggerSweeperDuration",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"secret",
"priorityClassName"
],
"title": "The jobservice Schema",
"type": "object"
},
"logLevel": {
"default": "",
"examples": [
"info"
],
"title": "The logLevel Schema",
"type": "string"
},
"metrics": {
"default": {},
"examples": [
{
"core": {
"path": "/metrics",
"port": 8001
},
"enabled": false,
"exporter": {
"path": "/metrics",
"port": 8001
},
"jobservice": {
"path": "/metrics",
"port": 8001
},
"registry": {
"path": "/metrics",
"port": 8001
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
}
],
"properties": {
"core": {
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 0,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"path",
"port"
],
"title": "The core Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"exporter": {
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 0,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"path",
"port"
],
"title": "The exporter Schema",
"type": "object"
},
"jobservice": {
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 0,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"path",
"port"
],
"title": "The jobservice Schema",
"type": "object"
},
"registry": {
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 0,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"path",
"port"
],
"title": "The registry Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "",
"examples": [
""
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The metricRelabelings Schema",
"type": "array"
},
"relabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The relabelings Schema",
"type": "array"
}
},
"required": [
"enabled",
"additionalLabels",
"interval",
"metricRelabelings",
"relabelings"
],
"title": "The serviceMonitor Schema",
"type": "object"
}
},
"required": [
"enabled",
"core",
"registry",
"jobservice",
"exporter",
"serviceMonitor"
],
"title": "The metrics Schema",
"type": "object"
},
"nginx": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-nginx\"=>nil}": null
},
"repository": "harbor/harbor-nginx"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-nginx\"=>nil}": null
},
"repository": "harbor/harbor-nginx"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-nginx\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-nginx\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-nginx\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-nginx\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-nginx"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 0,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"serviceAccountName",
"automountServiceAccountToken",
"replicas",
"revisionHistoryLimit",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The nginx Schema",
"type": "object"
},
"notary": {
"default": {},
"examples": [
{
"enabled": false,
"secretName": "",
"server": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-notary-server\"=>nil}": null
},
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
},
"signer": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-notary-signer\"=>nil}": null
},
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"server": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-notary-server\"=>nil}": null
},
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-notary-server\"=>nil}": null
},
"repository": "harbor/harbor-notary-server"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-notary-server\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-notary-server\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-notary-server\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-notary-server\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-notary-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"image",
"replicas",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The server Schema",
"type": "object"
},
"signer": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-notary-signer\"=>nil}": null
},
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-notary-signer\"=>nil}": null
},
"repository": "harbor/harbor-notary-signer"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-notary-signer\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-notary-signer\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-notary-signer\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-notary-signer\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-notary-signer"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"image",
"replicas",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The signer Schema",
"type": "object"
}
},
"required": [
"enabled",
"server",
"signer",
"secretName"
],
"title": "The notary Schema",
"type": "object"
},
"persistence": {
"default": {},
"examples": [
{
"enabled": true,
"imageChartStorage": {
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
},
"persistentVolumeClaim": {
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
},
"resourcePolicy": "keep"
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"imageChartStorage": {
"default": {},
"examples": [
{
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
}
],
"properties": {
"azure": {
"default": {},
"examples": [
{
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
}
],
"properties": {
"accountkey": {
"default": "",
"examples": [
"base64encodedaccountkey"
],
"title": "The accountkey Schema",
"type": "string"
},
"accountname": {
"default": "",
"examples": [
"accountname"
],
"title": "The accountname Schema",
"type": "string"
},
"container": {
"default": "",
"examples": [
"containername"
],
"title": "The container Schema",
"type": "string"
}
},
"required": [
"accountname",
"accountkey",
"container"
],
"title": "The azure Schema",
"type": "object"
},
"disableredirect": {
"default": false,
"examples": [
false
],
"title": "The disableredirect Schema",
"type": "boolean"
},
"filesystem": {
"default": {},
"examples": [
{
"rootdirectory": "/storage"
}
],
"properties": {
"rootdirectory": {
"default": "",
"examples": [
"/storage"
],
"title": "The rootdirectory Schema",
"type": "string"
}
},
"required": [
"rootdirectory"
],
"title": "The filesystem Schema",
"type": "object"
},
"gcs": {
"default": {},
"examples": [
{
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
}
],
"properties": {
"bucket": {
"default": "",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"encodedkey": {
"default": "",
"examples": [
"base64-encoded-json-key-file"
],
"title": "The encodedkey Schema",
"type": "string"
}
},
"required": [
"bucket",
"encodedkey"
],
"title": "The gcs Schema",
"type": "object"
},
"oss": {
"default": {},
"examples": [
{
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
}
],
"properties": {
"accesskeyid": {
"default": "",
"examples": [
"accesskeyid"
],
"title": "The accesskeyid Schema",
"type": "string"
},
"accesskeysecret": {
"default": "",
"examples": [
"accesskeysecret"
],
"title": "The accesskeysecret Schema",
"type": "string"
},
"bucket": {
"default": "",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"region": {
"default": "",
"examples": [
"regionname"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [
"accesskeyid",
"accesskeysecret",
"region",
"bucket"
],
"title": "The oss Schema",
"type": "object"
},
"s3": {
"default": {},
"examples": [
{
"bucket": "bucketname",
"region": "us-west-1"
}
],
"properties": {
"bucket": {
"default": "",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"region": {
"default": "",
"examples": [
"us-west-1"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [
"region",
"bucket"
],
"title": "The s3 Schema",
"type": "object"
},
"swift": {
"default": {},
"examples": [
{
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
}
],
"properties": {
"authurl": {
"default": "",
"examples": [
"https://storage.myprovider.com/v3/auth"
],
"title": "The authurl Schema",
"type": "string"
},
"container": {
"default": "",
"examples": [
"containername"
],
"title": "The container Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
"password"
],
"title": "The password Schema",
"type": "string"
},
"username": {
"default": "",
"examples": [
"username"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"authurl",
"username",
"password",
"container"
],
"title": "The swift Schema",
"type": "object"
},
"type": {
"default": "",
"examples": [
"filesystem"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"disableredirect",
"type",
"filesystem",
"azure",
"gcs",
"s3",
"swift",
"oss"
],
"title": "The imageChartStorage Schema",
"type": "object"
},
"persistentVolumeClaim": {
"default": {},
"examples": [
{
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
}
],
"properties": {
"chartmuseum": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The chartmuseum Schema",
"type": "object"
},
"database": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The database Schema",
"type": "object"
},
"jobservice": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The jobservice Schema",
"type": "object"
},
"redis": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The redis Schema",
"type": "object"
},
"registry": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The registry Schema",
"type": "object"
},
"trivy": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The trivy Schema",
"type": "object"
}
},
"required": [
"registry",
"chartmuseum",
"jobservice",
"database",
"redis",
"trivy"
],
"title": "The persistentVolumeClaim Schema",
"type": "object"
},
"resourcePolicy": {
"default": "",
"examples": [
"keep"
],
"title": "The resourcePolicy Schema",
"type": "string"
}
},
"required": [
"enabled",
"resourcePolicy",
"persistentVolumeClaim",
"imageChartStorage"
],
"title": "The persistence Schema",
"type": "object"
},
"portal": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-portal\"=>nil}": null
},
"repository": "harbor/harbor-portal"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-portal\"=>nil}": null
},
"repository": "harbor/harbor-portal"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-portal\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-portal\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-portal\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-portal\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-portal"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 0,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"serviceAccountName",
"automountServiceAccountToken",
"replicas",
"revisionHistoryLimit",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The portal Schema",
"type": "object"
},
"proxy": {
"default": {},
"examples": [
{
"components": [
"core",
"jobservice",
"trivy"
],
"httpProxy": null,
"httpsProxy": null,
"noProxy": "127.0.0.1,localhost,.local,.internal"
}
],
"properties": {
"components": {
"default": [],
"examples": [
[
"core",
"jobservice",
"trivy"
]
],
"items": {
"examples": [
"core",
"jobservice",
"trivy"
],
"title": "A Schema",
"type": "string"
},
"title": "The components Schema",
"type": "array"
},
"httpProxy": {
"default": null,
"examples": [
null
],
"title": "The httpProxy Schema",
"type": "null"
},
"httpsProxy": {
"default": null,
"examples": [
null
],
"title": "The httpsProxy Schema",
"type": "null"
},
"noProxy": {
"default": "",
"examples": [
"127.0.0.1,localhost,.local,.internal"
],
"title": "The noProxy Schema",
"type": "string"
}
},
"required": [
"httpProxy",
"httpsProxy",
"noProxy",
"components"
],
"title": "The proxy Schema",
"type": "object"
},
"redis": {
"default": {},
"examples": [
{
"external": {
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-redis\"=>nil}": null
},
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
},
"podAnnotations": {},
"type": "internal"
}
],
"properties": {
"external": {
"default": {},
"examples": [
{
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
}
],
"properties": {
"addr": {
"default": "",
"examples": [
"192.168.0.2:6379"
],
"title": "The addr Schema",
"type": "string"
},
"chartmuseumDatabaseIndex": {
"default": "",
"examples": [
"3"
],
"title": "The chartmuseumDatabaseIndex Schema",
"type": "string"
},
"coreDatabaseIndex": {
"default": "",
"examples": [
"0"
],
"title": "The coreDatabaseIndex Schema",
"type": "string"
},
"jobserviceDatabaseIndex": {
"default": "",
"examples": [
"1"
],
"title": "The jobserviceDatabaseIndex Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
""
],
"title": "The password Schema",
"type": "string"
},
"registryDatabaseIndex": {
"default": "",
"examples": [
"2"
],
"title": "The registryDatabaseIndex Schema",
"type": "string"
},
"sentinelMasterSet": {
"default": "",
"examples": [
""
],
"title": "The sentinelMasterSet Schema",
"type": "string"
},
"trivyAdapterIndex": {
"default": "",
"examples": [
"5"
],
"title": "The trivyAdapterIndex Schema",
"type": "string"
}
},
"required": [
"addr",
"sentinelMasterSet",
"coreDatabaseIndex",
"jobserviceDatabaseIndex",
"registryDatabaseIndex",
"chartmuseumDatabaseIndex",
"trivyAdapterIndex",
"password"
],
"title": "The external Schema",
"type": "object"
},
"internal": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": {
"{\"harbor/harbor-redis\"=>nil}": null
},
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-redis\"=>nil}": null
},
"repository": "harbor/harbor-redis"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-redis\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-redis\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-redis\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-redis\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-redis"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"image",
"nodeSelector",
"tolerations",
"affinity",
"priorityClassName"
],
"title": "The internal Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"type": {
"default": "",
"examples": [
"internal"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"internal",
"external",
"podAnnotations"
],
"title": "The redis Schema",
"type": "object"
},
"registry": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"controller": {
"image": {
"digest": {
"{\"harbor/harbor-registryctl\"=>nil}": null
},
"repository": "harbor/harbor-registryctl"
}
},
"credentials": {
"password": "harbor_registry_password",
"username": "harbor_registry_user"
},
"middleware": {
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"registry": {
"image": {
"digest": {
"{\"harbor/harbor-registry\"=>nil}": null
},
"repository": "harbor/harbor-registry"
}
},
"relativeurls": false,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": [],
"upload_purging": {
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"controller": {
"default": {},
"examples": [
{
"image": {
"digest": {
"{\"harbor/harbor-registryctl\"=>nil}": null
},
"repository": "harbor/harbor-registryctl"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-registryctl\"=>nil}": null
},
"repository": "harbor/harbor-registryctl"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-registryctl\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-registryctl\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-registryctl\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-registryctl\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-registryctl"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The controller Schema",
"type": "object"
},
"credentials": {
"default": {},
"examples": [
{
"password": "harbor_registry_password",
"username": "harbor_registry_user"
}
],
"properties": {
"password": {
"default": "",
"examples": [
"harbor_registry_password"
],
"title": "The password Schema",
"type": "string"
},
"username": {
"default": "",
"examples": [
"harbor_registry_user"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"username",
"password"
],
"title": "The credentials Schema",
"type": "object"
},
"middleware": {
"default": {},
"examples": [
{
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
}
],
"properties": {
"cloudFront": {
"default": {},
"examples": [
{
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
}
],
"properties": {
"baseurl": {
"default": "",
"examples": [
"example.cloudfront.net"
],
"title": "The baseurl Schema",
"type": "string"
},
"duration": {
"default": "",
"examples": [
"3000s"
],
"title": "The duration Schema",
"type": "string"
},
"ipfilteredby": {
"default": "",
"examples": [
"none"
],
"title": "The ipfilteredby Schema",
"type": "string"
},
"keypairid": {
"default": "",
"examples": [
"KEYPAIRID"
],
"title": "The keypairid Schema",
"type": "string"
},
"privateKeySecret": {
"default": "",
"examples": [
"my-secret"
],
"title": "The privateKeySecret Schema",
"type": "string"
}
},
"required": [
"baseurl",
"keypairid",
"duration",
"ipfilteredby",
"privateKeySecret"
],
"title": "The cloudFront Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"type": {
"default": "",
"examples": [
"cloudFront"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"enabled",
"type",
"cloudFront"
],
"title": "The middleware Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"registry": {
"default": {},
"examples": [
{
"image": {
"digest": {
"{\"harbor/harbor-registry\"=>nil}": null
},
"repository": "harbor/harbor-registry"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-registry\"=>nil}": null
},
"repository": "harbor/harbor-registry"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-registry\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-registry\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-registry\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-registry\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-registry"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The registry Schema",
"type": "object"
},
"relativeurls": {
"default": false,
"examples": [
false
],
"title": "The relativeurls Schema",
"type": "boolean"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 0,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"upload_purging": {
"default": {},
"examples": [
{
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
],
"properties": {
"age": {
"default": "",
"examples": [
"168h"
],
"title": "The age Schema",
"type": "string"
},
"dryrun": {
"default": false,
"examples": [
false
],
"title": "The dryrun Schema",
"type": "boolean"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "",
"examples": [
"24h"
],
"title": "The interval Schema",
"type": "string"
}
},
"required": [
"enabled",
"age",
"interval",
"dryrun"
],
"title": "The upload_purging Schema",
"type": "object"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"registry",
"controller",
"replicas",
"revisionHistoryLimit",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName",
"secret",
"relativeurls",
"credentials",
"middleware",
"upload_purging"
],
"title": "The registry Schema",
"type": "object"
},
"secretKey": {
"default": "",
"examples": [
""
],
"title": "The secretKey Schema",
"type": "string"
},
"sourceRegistry": {
"default": "",
"examples": [
"public.ecr.aws/eks-anywhere"
],
"title": "The sourceRegistry Schema",
"type": "string"
},
"trace": {
"default": {},
"examples": [
{
"enabled": false,
"jaeger": {
"endpoint": "http://hostname:14268/api/traces"
},
"otel": {
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
},
"provider": "jaeger",
"sample_rate": 1
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"jaeger": {
"default": {},
"examples": [
{
"endpoint": "http://hostname:14268/api/traces"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://hostname:14268/api/traces"
],
"title": "The endpoint Schema",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "The jaeger Schema",
"type": "object"
},
"otel": {
"default": {},
"examples": [
{
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
}
],
"properties": {
"compression": {
"default": false,
"examples": [
false
],
"title": "The compression Schema",
"type": "boolean"
},
"endpoint": {
"default": "",
"examples": [
"hostname:4318"
],
"title": "The endpoint Schema",
"type": "string"
},
"insecure": {
"default": false,
"examples": [
true
],
"title": "The insecure Schema",
"type": "boolean"
},
"timeout": {
"default": "",
"examples": [
"10s"
],
"title": "The timeout Schema",
"type": "string"
},
"url_path": {
"default": "",
"examples": [
"/v1/traces"
],
"title": "The url_path Schema",
"type": "string"
}
},
"required": [
"endpoint",
"url_path",
"compression",
"insecure",
"timeout"
],
"title": "The otel Schema",
"type": "object"
},
"provider": {
"default": "",
"examples": [
"jaeger"
],
"title": "The provider Schema",
"type": "string"
},
"sample_rate": {
"default": 0,
"examples": [
1
],
"title": "The sample_rate Schema",
"type": "integer"
}
},
"required": [
"enabled",
"provider",
"sample_rate",
"jaeger",
"otel"
],
"title": "The trace Schema",
"type": "object"
},
"trivy": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"debugMode": false,
"enabled": true,
"gitHubToken": "",
"ignoreUnfixed": false,
"image": {
"digest": {
"{\"harbor/harbor-trivy\"=>nil}": null
},
"repository": "harbor/harbor-trivy"
},
"insecure": false,
"nodeSelector": {},
"offlineScan": false,
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"resources": {
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
},
"serviceAccountName": "",
"severity": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"skipUpdate": false,
"timeout": "5m0s",
"tolerations": [],
"vulnType": "os,library"
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"debugMode": {
"default": false,
"examples": [
false
],
"title": "The debugMode Schema",
"type": "boolean"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"gitHubToken": {
"default": "",
"examples": [
""
],
"title": "The gitHubToken Schema",
"type": "string"
},
"ignoreUnfixed": {
"default": false,
"examples": [
false
],
"title": "The ignoreUnfixed Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": {
"{\"harbor/harbor-trivy\"=>nil}": null
},
"repository": "harbor/harbor-trivy"
}
],
"properties": {
"digest": {
"default": {},
"examples": [
{
"{\"harbor/harbor-trivy\"=>nil}": null
}
],
"properties": {
"{\"harbor/harbor-trivy\"=>nil}": {
"default": null,
"examples": [
null
],
"title": "The {\"harbor/harbor-trivy\"=>nil} Schema",
"type": "null"
}
},
"required": [
"{\"harbor/harbor-trivy\"=>nil}"
],
"title": "The digest Schema",
"type": "object"
},
"repository": {
"default": "",
"examples": [
"harbor/harbor-trivy"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"insecure": {
"default": false,
"examples": [
false
],
"title": "The insecure Schema",
"type": "boolean"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"offlineScan": {
"default": false,
"examples": [
false
],
"title": "The offlineScan Schema",
"type": "boolean"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 0,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": 1,
"memory": "1Gi"
}
],
"properties": {
"cpu": {
"default": 0,
"examples": [
1
],
"title": "The cpu Schema",
"type": "integer"
},
"memory": {
"default": "",
"examples": [
"1Gi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "200m",
"memory": "512Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"200m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"512Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "The resources Schema",
"type": "object"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"severity": {
"default": "",
"examples": [
"UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL"
],
"title": "The severity Schema",
"type": "string"
},
"skipUpdate": {
"default": false,
"examples": [
false
],
"title": "The skipUpdate Schema",
"type": "boolean"
},
"timeout": {
"default": "",
"examples": [
"5m0s"
],
"title": "The timeout Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"vulnType": {
"default": "",
"examples": [
"os,library"
],
"title": "The vulnType Schema",
"type": "string"
}
},
"required": [
"enabled",
"image",
"serviceAccountName",
"automountServiceAccountToken",
"replicas",
"debugMode",
"vulnType",
"severity",
"ignoreUnfixed",
"insecure",
"gitHubToken",
"skipUpdate",
"offlineScan",
"timeout",
"resources",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The trivy Schema",
"type": "object"
},
"updateStrategy": {
"default": {},
"examples": [
{
"type": "Recreate"
}
],
"properties": {
"type": {
"default": "",
"examples": [
"Recreate"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type"
],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"required": [
"sourceRegistry",
"expose",
"externalURL",
"internalTLS",
"ipFamily",
"persistence",
"imagePullPolicy",
"imagePullSecrets",
"updateStrategy",
"logLevel",
"harborAdminPassword",
"caSecretName",
"secretKey",
"proxy",
"enableMigrateHelmHook",
"nginx",
"portal",
"core",
"jobservice",
"registry",
"chartmuseum",
"trivy",
"notary",
"database",
"redis",
"exporter",
"metrics",
"trace"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 25189db514f5e0c07e7a78016dd5ed13195e42fa | 2024-04-12T19:15:48 | projects/kubernetes/autoscaler/1-30/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"additionalLabels": {},
"affinity": {},
"autoDiscovery": {
"clusterName": "my-cluster",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
},
"autoscalingGroups": [],
"autoscalingGroupsnamePrefix": [],
"awsAccessKeyID": "",
"awsRegion": "us-east-1",
"awsSecretAccessKey": "",
"azureClientID": "",
"azureClientSecret": "",
"azureClusterName": "",
"azureNodeResourceGroup": "",
"azureResourceGroup": "",
"azureSubscriptionID": "",
"azureTenantID": "",
"azureUseManagedIdentityExtension": false,
"azureVMType": "AKS",
"cloudConfigPath": "",
"cloudProvider": "clusterapi",
"clusterAPICloudConfigPath": "/etc/kubernetes/mgmt-kubeconfig",
"clusterAPIConfigMapsNamespace": "",
"clusterAPIKubeconfigSecret": "",
"clusterAPIMode": "incluster-incluster",
"clusterAPIWorkloadKubeconfigPath": "/etc/kubernetes/value",
"containerSecurityContext": {},
"deployment": {
"annotations": {}
},
"dnsPolicy": "ClusterFirst",
"envFromConfigMap": "",
"envFromSecret": "",
"expanderPriorities": {},
"extraArgs": {
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
},
"extraEnv": {},
"extraEnvConfigMaps": {},
"extraEnvSecrets": {},
"extraVolumeMounts": [],
"extraVolumeSecrets": {},
"extraVolumes": [],
"fullnameOverride": "",
"image": {
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
},
"imagePullSecrets": [],
"kubeTargetVersionOverride": "",
"magnumCABundlePath": "/etc/kubernetes/ca-bundle.crt",
"magnumClusterName": "",
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"maxUnavailable": 1
},
"podLabels": {},
"priorityClassName": "system-cluster-critical",
"priorityConfigMapAnnotations": {},
"prometheusRule": {
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
},
"rbac": {
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
},
"replicaCount": 1,
"resources": {},
"securityContext": {},
"service": {
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
},
"sourceRegistry": "public.ecr.aws",
"tolerations": [],
"topologySpreadConstraints": [],
"updateStrategy": {}
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"autoDiscovery": {
"default": {},
"examples": [
{
"clusterName": "my-cluster-name",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
}
],
"properties": {
"clusterName": {
"default": "",
"examples": [
"my-cluster-name"
],
"title": "The clusterName Schema",
"type": "string"
},
"labels": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The labels Schema",
"type": "array"
},
"roles": {
"default": [],
"examples": [
[
"worker"
]
],
"items": {
"default": "",
"examples": [
"worker"
],
"title": "A Schema",
"type": "string"
},
"title": "The roles Schema",
"type": "array"
},
"tags": {
"default": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"examples": [
[
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
],
"items": {
"examples": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"title": "A Schema",
"type": "string"
},
"title": "The tags Schema",
"type": "array"
}
},
"required": [],
"title": "The autoDiscovery Schema",
"type": "object"
},
"autoscalingGroups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroups Schema",
"type": "array"
},
"autoscalingGroupsnamePrefix": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroupsnamePrefix Schema",
"type": "array"
},
"awsAccessKeyID": {
"default": "",
"examples": [
""
],
"title": "The awsAccessKeyID Schema",
"type": "string"
},
"awsRegion": {
"default": "",
"examples": [
"us-east-1"
],
"title": "The awsRegion Schema",
"type": "string"
},
"awsSecretAccessKey": {
"default": "",
"examples": [
""
],
"title": "The awsSecretAccessKey Schema",
"type": "string"
},
"azureClientID": {
"default": "",
"examples": [
""
],
"title": "The azureClientID Schema",
"type": "string"
},
"azureClientSecret": {
"default": "",
"examples": [
""
],
"title": "The azureClientSecret Schema",
"type": "string"
},
"azureClusterName": {
"default": "",
"examples": [
""
],
"title": "The azureClusterName Schema",
"type": "string"
},
"azureNodeResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureNodeResourceGroup Schema",
"type": "string"
},
"azureResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureResourceGroup Schema",
"type": "string"
},
"azureSubscriptionID": {
"default": "",
"examples": [
""
],
"title": "The azureSubscriptionID Schema",
"type": "string"
},
"azureTenantID": {
"default": "",
"examples": [
""
],
"title": "The azureTenantID Schema",
"type": "string"
},
"azureUseManagedIdentityExtension": {
"default": false,
"examples": [
false
],
"title": "The azureUseManagedIdentityExtension Schema",
"type": "boolean"
},
"azureVMType": {
"default": "",
"examples": [
"AKS"
],
"title": "The azureVMType Schema",
"type": "string"
},
"cloudConfigPath": {
"default": "",
"examples": [
""
],
"title": "The cloudConfigPath Schema",
"type": "string"
},
"cloudProvider": {
"default": "",
"examples": [
"clusterapi"
],
"title": "The cloudProvider Schema",
"type": "string"
},
"clusterAPICloudConfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/mgmt-kubeconfig"
],
"title": "The clusterAPICloudConfigPath Schema",
"type": "string"
},
"clusterAPIConfigMapsNamespace": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIConfigMapsNamespace Schema",
"type": "string"
},
"clusterAPIKubeconfigSecret": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIKubeconfigSecret Schema",
"type": "string"
},
"clusterAPIMode": {
"default": "",
"examples": [
"incluster-incluster"
],
"title": "The clusterAPIMode Schema",
"type": "string"
},
"clusterAPIWorkloadKubeconfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/value"
],
"title": "The clusterAPIWorkloadKubeconfigPath Schema",
"type": "string"
},
"containerSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The containerSecurityContext Schema",
"type": "object"
},
"deployment": {
"default": {},
"examples": [
{
"annotations": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
}
},
"required": [
"annotations"
],
"title": "The deployment Schema",
"type": "object"
},
"dnsPolicy": {
"default": "",
"examples": [
"ClusterFirst"
],
"title": "The dnsPolicy Schema",
"type": "string"
},
"envFromConfigMap": {
"default": "",
"examples": [
""
],
"title": "The envFromConfigMap Schema",
"type": "string"
},
"envFromSecret": {
"default": "",
"examples": [
""
],
"title": "The envFromSecret Schema",
"type": "string"
},
"expanderPriorities": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The expanderPriorities Schema",
"type": "object"
},
"extraArgs": {
"default": {},
"examples": [
{
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
}
],
"properties": {
"logtostderr": {
"default": true,
"examples": [
true
],
"title": "The logtostderr Schema",
"type": "boolean"
},
"stderrthreshold": {
"default": "info",
"examples": [
"info"
],
"title": "The stderrthreshold Schema",
"type": "string"
},
"v": {
"default": 4,
"examples": [
4
],
"title": "The v Schema",
"type": "integer"
}
},
"required": [],
"title": "The extraArgs Schema",
"type": "object"
},
"extraEnv": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnv Schema",
"type": "object"
},
"extraEnvConfigMaps": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvConfigMaps Schema",
"type": "object"
},
"extraEnvSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvSecrets Schema",
"type": "object"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumeSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraVolumeSecrets Schema",
"type": "object"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "kubernetes/autoscaler",
"examples": [
"kubernetes/autoscaler"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeTargetVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeTargetVersionOverride Schema",
"type": "string"
},
"magnumCABundlePath": {
"default": "",
"examples": [
"/etc/kubernetes/ca-bundle.crt"
],
"title": "The magnumCABundlePath Schema",
"type": "string"
},
"magnumClusterName": {
"default": "",
"examples": [
""
],
"title": "The magnumClusterName Schema",
"type": "string"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"maxUnavailable": 1
}
],
"properties": {
"maxUnavailable": {
"default": 1,
"examples": [
1
],
"title": "The maxUnavailable Schema",
"type": "integer"
}
},
"required": [
"maxUnavailable"
],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"priorityConfigMapAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The priorityConfigMapAnnotations Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"rules": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The rules Schema",
"type": "array"
}
},
"required": [],
"title": "The prometheusRule Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
}
],
"properties": {
"clusterScoped": {
"default": true,
"examples": [
true
],
"title": "The clusterScoped Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"externalIPs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The externalIPs Schema",
"type": "array"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"loadBalancerIP": {
"default": "",
"examples": [
""
],
"title": "The loadBalancerIP Schema",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The loadBalancerSourceRanges Schema",
"type": "array"
},
"portName": {
"default": "http",
"examples": [
"http"
],
"title": "The portName Schema",
"type": "string"
},
"servicePort": {
"default": 8085,
"examples": [
8085
],
"title": "The servicePort Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The metricRelabelings Schema",
"type": "object"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"selector": {
"default": {},
"examples": [
{
"release": "prometheus-operator"
}
],
"properties": {
"release": {
"default": "prometheus-operator",
"examples": [
"prometheus-operator"
],
"title": "The release Schema",
"type": "string"
}
},
"required": [],
"title": "The selector Schema",
"type": "object"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 6c4d6c6821a10679db4c06c6ade8ac0ab723d6e6 | 2022-08-11T22:25:34 | projects/goharbor/harbor/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"caSecretName": "",
"chartmuseum": {
"absoluteUrl": false,
"affinity": {},
"automountServiceAccountToken": false,
"enabled": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
},
"indexLimit": 0,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"core": {
"affinity": {},
"artifactPullAsyncFlushDuration": null,
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7ae78dc49fa911872ab4a4e63e82645c442fc7a4eece4047701a18cf2849d076",
"repository": "harbor/harbor-core"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"secretName": "",
"serviceAccountName": "",
"startupProbe": {
"enabled": true,
"initialDelaySeconds": 10
},
"tolerations": [],
"xsrfKey": ""
},
"database": {
"external": {
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
},
"maxIdleConns": 100,
"maxOpenConns": 900,
"podAnnotations": {},
"type": "internal"
},
"enableMigrateHelmHook": false,
"exporter": {
"affinity": {},
"automountServiceAccountToken": false,
"cacheCleanInterval": 14400,
"cacheDuration": 23,
"image": {
"digest": "sha256:b094bdbb1248bab4a845a512a7aebc0de3b63724b15a0bd5bf03eadbb9c7e73b",
"repository": "harbor/harbor-exporter"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"expose": {
"clusterIP": {
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
},
"ingress": {
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
},
"loadBalancer": {
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
},
"nodePort": {
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
},
"tls": {
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
},
"type": "nodePort"
},
"externalURL": "https://127.0.0.1:30003",
"harborAdminPassword": "Harbor12345",
"imagePullPolicy": "IfNotPresent",
"imagePullSecrets": null,
"internalTLS": {
"certSource": "auto",
"chartmuseum": {
"crt": "",
"key": "",
"secretName": ""
},
"core": {
"crt": "",
"key": "",
"secretName": ""
},
"enabled": true,
"jobservice": {
"crt": "",
"key": "",
"secretName": ""
},
"portal": {
"crt": "",
"key": "",
"secretName": ""
},
"registry": {
"crt": "",
"key": "",
"secretName": ""
},
"trivy": {
"crt": "",
"key": "",
"secretName": ""
},
"trustCa": ""
},
"ipFamily": {
"ipv4": {
"enabled": true
},
"ipv6": {
"enabled": true
}
},
"jobservice": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:31935f48613fef7c148b9abbcd578744f56052d59b1410ee20989467a45118a8",
"repository": "harbor/harbor-jobservice"
},
"jobLoggers": [
"file"
],
"loggerSweeperDuration": 14,
"maxJobWorkers": 10,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": []
},
"logLevel": "info",
"metrics": {
"core": {
"path": "/metrics",
"port": 8001
},
"enabled": false,
"exporter": {
"path": "/metrics",
"port": 8001
},
"jobservice": {
"path": "/metrics",
"port": 8001
},
"registry": {
"path": "/metrics",
"port": 8001
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
},
"nginx": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:9854ecee686c3ff4868f90bab75d232b057a683168e1852df9f3fca33bfefa7d",
"repository": "harbor/harbor-nginx"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"notary": {
"enabled": false,
"secretName": "",
"server": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
},
"signer": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
},
"persistence": {
"enabled": true,
"imageChartStorage": {
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
},
"persistentVolumeClaim": {
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
},
"resourcePolicy": "keep"
},
"portal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:0256993eb356948ba2dfd6e969d2f8da903b849a25a31010a7250931c4d694e5",
"repository": "harbor/harbor-portal"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"proxy": {
"components": [
"core",
"jobservice",
"trivy"
],
"httpProxy": null,
"httpsProxy": null,
"noProxy": "127.0.0.1,localhost,.local,.internal"
},
"redis": {
"external": {
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
},
"podAnnotations": {},
"type": "internal"
},
"registry": {
"affinity": {},
"automountServiceAccountToken": false,
"controller": {
"image": {
"digest": "sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761",
"repository": "harbor/harbor-registryctl"
}
},
"credentials": {
"password": "harbor_registry_password",
"username": "harbor_registry_user"
},
"middleware": {
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"registry": {
"image": {
"digest": "sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3",
"repository": "harbor/harbor-registry"
}
},
"relativeurls": false,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": [],
"upload_purging": {
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
},
"secretKey": "",
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"trace": {
"enabled": false,
"jaeger": {
"endpoint": "http://hostname:14268/api/traces"
},
"otel": {
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
},
"provider": "jaeger",
"sample_rate": 1
},
"trivy": {
"affinity": {},
"automountServiceAccountToken": false,
"debugMode": false,
"enabled": true,
"gitHubToken": "",
"ignoreUnfixed": false,
"image": {
"digest": "sha256:829fc3d40ba7423280ed8d7a51ea6345283fa35c21177998902f5b311f5be0be",
"repository": "harbor/harbor-trivy"
},
"insecure": false,
"nodeSelector": {},
"offlineScan": false,
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"resources": {
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
},
"serviceAccountName": "",
"severity": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"skipUpdate": false,
"timeout": "5m0s",
"tolerations": [],
"vulnType": "os,library"
},
"updateStrategy": {
"type": "Recreate"
}
}
],
"properties": {
"caSecretName": {
"default": "",
"examples": [
""
],
"title": "The caSecretName Schema",
"type": "string"
},
"chartmuseum": {
"additionalProperties": false,
"default": {},
"examples": [
{
"absoluteUrl": false,
"affinity": {},
"automountServiceAccountToken": false,
"enabled": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
},
"indexLimit": 0,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"absoluteUrl": {
"default": false,
"examples": [
false
],
"title": "The absoluteUrl Schema",
"type": "boolean"
},
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-chartmuseum",
"examples": [
"harbor/harbor-chartmuseum"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"indexLimit": {
"default": 0,
"examples": [
0
],
"title": "The indexLimit Schema",
"type": "integer"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The chartmuseum Schema",
"type": "object"
},
"core": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"artifactPullAsyncFlushDuration": null,
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7ae78dc49fa911872ab4a4e63e82645c442fc7a4eece4047701a18cf2849d076",
"repository": "harbor/harbor-core"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"secretName": "",
"serviceAccountName": "",
"startupProbe": {
"enabled": true,
"initialDelaySeconds": 10
},
"tolerations": [],
"xsrfKey": ""
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"artifactPullAsyncFlushDuration": {
"default": null,
"examples": [
null
],
"title": "The artifactPullAsyncFlushDuration Schema",
"type": "null"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:7ae78dc49fa911872ab4a4e63e82645c442fc7a4eece4047701a18cf2849d076",
"repository": "harbor/harbor-core"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7ae78dc49fa911872ab4a4e63e82645c442fc7a4eece4047701a18cf2849d076"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-core",
"examples": [
"harbor/harbor-core"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"startupProbe": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"initialDelaySeconds": 10
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"initialDelaySeconds": {
"default": 10,
"examples": [
10
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The startupProbe Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"xsrfKey": {
"default": "",
"examples": [
""
],
"title": "The xsrfKey Schema",
"type": "string"
}
},
"required": [],
"title": "The core Schema",
"type": "object"
},
"database": {
"additionalProperties": false,
"default": {},
"examples": [
{
"external": {
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
},
"maxIdleConns": 100,
"maxOpenConns": 900,
"podAnnotations": {},
"type": "internal"
}
],
"properties": {
"external": {
"additionalProperties": false,
"default": {},
"examples": [
{
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
}
],
"properties": {
"coreDatabase": {
"default": "registry",
"examples": [
"registry"
],
"title": "The coreDatabase Schema",
"type": "string"
},
"host": {
"default": "192.168.0.1",
"examples": [
"192.168.0.1"
],
"title": "The host Schema",
"type": "string"
},
"notaryServerDatabase": {
"default": "notary_server",
"examples": [
"notary_server"
],
"title": "The notaryServerDatabase Schema",
"type": "string"
},
"notarySignerDatabase": {
"default": "notary_signer",
"examples": [
"notary_signer"
],
"title": "The notarySignerDatabase Schema",
"type": "string"
},
"password": {
"default": "password",
"examples": [
"password"
],
"title": "The password Schema",
"type": "string"
},
"port": {
"default": "5432",
"examples": [
"5432"
],
"title": "The port Schema",
"type": "string"
},
"sslmode": {
"default": "disable",
"examples": [
"disable"
],
"title": "The sslmode Schema",
"type": "string"
},
"username": {
"default": "user",
"examples": [
"user"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [],
"title": "The external Schema",
"type": "object"
},
"internal": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5",
"repository": "harbor/harbor-db"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-db",
"examples": [
"harbor/harbor-db"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"initContainer": {
"additionalProperties": false,
"default": {},
"examples": [
{
"migrator": {},
"permissions": {}
}
],
"properties": {
"migrator": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The migrator Schema",
"type": "object"
},
"permissions": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The permissions Schema",
"type": "object"
}
},
"required": [],
"title": "The initContainer Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"password": {
"default": "changeit",
"examples": [
"changeit"
],
"title": "The password Schema",
"type": "string"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"shmSizeLimit": {
"default": "512Mi",
"examples": [
"512Mi"
],
"title": "The shmSizeLimit Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The internal Schema",
"type": "object"
},
"maxIdleConns": {
"default": 100,
"examples": [
100
],
"title": "The maxIdleConns Schema",
"type": "integer"
},
"maxOpenConns": {
"default": 900,
"examples": [
900
],
"title": "The maxOpenConns Schema",
"type": "integer"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"type": {
"default": "internal",
"examples": [
"internal"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The database Schema",
"type": "object"
},
"enableMigrateHelmHook": {
"default": false,
"examples": [
false
],
"title": "The enableMigrateHelmHook Schema",
"type": "boolean"
},
"exporter": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"cacheCleanInterval": 14400,
"cacheDuration": 23,
"image": {
"digest": "sha256:b094bdbb1248bab4a845a512a7aebc0de3b63724b15a0bd5bf03eadbb9c7e73b",
"repository": "harbor/harbor-exporter"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"cacheCleanInterval": {
"default": 14400,
"examples": [
14400
],
"title": "The cacheCleanInterval Schema",
"type": "integer"
},
"cacheDuration": {
"default": 23,
"examples": [
23
],
"title": "The cacheDuration Schema",
"type": "integer"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:b094bdbb1248bab4a845a512a7aebc0de3b63724b15a0bd5bf03eadbb9c7e73b",
"repository": "harbor/harbor-exporter"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:b094bdbb1248bab4a845a512a7aebc0de3b63724b15a0bd5bf03eadbb9c7e73b"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-exporter",
"examples": [
"harbor/harbor-exporter"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The exporter Schema",
"type": "object"
},
"expose": {
"additionalProperties": false,
"default": {},
"examples": [
{
"clusterIP": {
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
},
"ingress": {
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
},
"loadBalancer": {
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
},
"nodePort": {
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
},
"tls": {
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
},
"type": "nodePort"
}
],
"properties": {
"clusterIP": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
}
],
"properties": {
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
],
"properties": {
"httpPort": {
"default": 80,
"examples": [
80
],
"title": "The httpPort Schema",
"type": "integer"
},
"httpsPort": {
"default": 443,
"examples": [
443
],
"title": "The httpsPort Schema",
"type": "integer"
},
"notaryPort": {
"default": 4443,
"examples": [
4443
],
"title": "The notaryPort Schema",
"type": "integer"
}
},
"required": [],
"title": "The ports Schema",
"type": "object"
}
},
"required": [],
"title": "The clusterIP Schema",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
}
],
"properties": {
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
}
],
"properties": {
"ingress.kubernetes.io/proxy-body-size": {
"default": "0",
"examples": [
"0"
],
"title": "The ingress.kubernetes.io/proxy-body-size Schema",
"type": "string"
},
"ingress.kubernetes.io/ssl-redirect": {
"default": "true",
"examples": [
"true"
],
"title": "The ingress.kubernetes.io/ssl-redirect Schema",
"type": "string"
},
"nginx.ingress.kubernetes.io/proxy-body-size": {
"default": "0",
"examples": [
"0"
],
"title": "The nginx.ingress.kubernetes.io/proxy-body-size Schema",
"type": "string"
},
"nginx.ingress.kubernetes.io/ssl-redirect": {
"default": "true",
"examples": [
"true"
],
"title": "The nginx.ingress.kubernetes.io/ssl-redirect Schema",
"type": "string"
}
},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"className": {
"default": "",
"examples": [
""
],
"title": "The className Schema",
"type": "string"
},
"controller": {
"default": "default",
"examples": [
"default"
],
"title": "The controller Schema",
"type": "string"
},
"harbor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"labels": {}
}
],
"properties": {
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
}
},
"required": [],
"title": "The harbor Schema",
"type": "object"
},
"hosts": {
"additionalProperties": false,
"default": {},
"examples": [
{
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
}
],
"properties": {
"core": {
"default": "core.harbor.domain",
"examples": [
"core.harbor.domain"
],
"title": "The core Schema",
"type": "string"
},
"notary": {
"default": "notary.harbor.domain",
"examples": [
"notary.harbor.domain"
],
"title": "The notary Schema",
"type": "string"
}
},
"required": [],
"title": "The hosts Schema",
"type": "object"
},
"kubeVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeVersionOverride Schema",
"type": "string"
},
"notary": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"labels": {}
}
],
"properties": {
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
}
},
"required": [],
"title": "The notary Schema",
"type": "object"
}
},
"required": [],
"title": "The ingress Schema",
"type": "object"
},
"loadBalancer": {
"additionalProperties": false,
"default": {},
"examples": [
{
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
}
],
"properties": {
"IP": {
"default": "",
"examples": [
""
],
"title": "The IP Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
],
"properties": {
"httpPort": {
"default": 80,
"examples": [
80
],
"title": "The httpPort Schema",
"type": "integer"
},
"httpsPort": {
"default": 443,
"examples": [
443
],
"title": "The httpsPort Schema",
"type": "integer"
},
"notaryPort": {
"default": 4443,
"examples": [
4443
],
"title": "The notaryPort Schema",
"type": "integer"
}
},
"required": [],
"title": "The ports Schema",
"type": "object"
},
"sourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The sourceRanges Schema",
"type": "array"
}
},
"required": [],
"title": "The loadBalancer Schema",
"type": "object"
},
"nodePort": {
"additionalProperties": false,
"default": {},
"examples": [
{
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
}
],
"properties": {
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
],
"properties": {
"http": {
"additionalProperties": false,
"default": {},
"examples": [
{
"nodePort": 30002,
"port": 80
}
],
"properties": {
"nodePort": {
"default": 30002,
"examples": [
30002
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 80,
"examples": [
80
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The http Schema",
"type": "object"
},
"https": {
"additionalProperties": false,
"default": {},
"examples": [
{
"nodePort": 30003,
"port": 443
}
],
"properties": {
"nodePort": {
"default": 30003,
"examples": [
30003
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The https Schema",
"type": "object"
},
"notary": {
"additionalProperties": false,
"default": {},
"examples": [
{
"nodePort": 30004,
"port": 4443
}
],
"properties": {
"nodePort": {
"default": 30004,
"examples": [
30004
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 4443,
"examples": [
4443
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The notary Schema",
"type": "object"
}
},
"required": [],
"title": "The ports Schema",
"type": "object"
}
},
"required": [],
"title": "The nodePort Schema",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"examples": [
{
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
}
],
"properties": {
"auto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"commonName": ""
}
],
"properties": {
"commonName": {
"default": "",
"examples": [
""
],
"title": "The commonName Schema",
"type": "string"
}
},
"required": [],
"title": "The auto Schema",
"type": "object"
},
"certSource": {
"default": "secret",
"examples": [
"secret"
],
"title": "The certSource Schema",
"type": "string"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"secret": {
"additionalProperties": false,
"default": {},
"examples": [
{
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
],
"properties": {
"notarySecretName": {
"default": "",
"examples": [
""
],
"title": "The notarySecretName Schema",
"type": "string"
},
"secretName": {
"default": "harbor-tls-secret",
"examples": [
"harbor-tls-secret"
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The secret Schema",
"type": "object"
}
},
"required": [],
"title": "The tls Schema",
"type": "object"
},
"type": {
"default": "nodePort",
"examples": [
"nodePort"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The expose Schema",
"type": "object"
},
"externalURL": {
"default": "https://127.0.0.1:30003",
"examples": [
"https://127.0.0.1:30003"
],
"title": "The externalURL Schema",
"type": "string"
},
"harborAdminPassword": {
"default": "Harbor12345",
"examples": [
"Harbor12345"
],
"title": "The harborAdminPassword Schema",
"type": "string"
},
"imagePullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The imagePullPolicy Schema",
"type": "string"
},
"imagePullSecrets": {
"default": null,
"examples": [
null
],
"title": "The imagePullSecrets Schema",
"type": "null"
},
"internalTLS": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certSource": "auto",
"chartmuseum": {
"crt": "",
"key": "",
"secretName": ""
},
"core": {
"crt": "",
"key": "",
"secretName": ""
},
"enabled": true,
"jobservice": {
"crt": "",
"key": "",
"secretName": ""
},
"portal": {
"crt": "",
"key": "",
"secretName": ""
},
"registry": {
"crt": "",
"key": "",
"secretName": ""
},
"trivy": {
"crt": "",
"key": "",
"secretName": ""
},
"trustCa": ""
}
],
"properties": {
"certSource": {
"default": "auto",
"examples": [
"auto"
],
"title": "The certSource Schema",
"type": "string"
},
"chartmuseum": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The chartmuseum Schema",
"type": "object"
},
"core": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The core Schema",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"jobservice": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The jobservice Schema",
"type": "object"
},
"portal": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The portal Schema",
"type": "object"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"trivy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The trivy Schema",
"type": "object"
},
"trustCa": {
"default": "",
"examples": [
""
],
"title": "The trustCa Schema",
"type": "string"
}
},
"required": [],
"title": "The internalTLS Schema",
"type": "object"
},
"ipFamily": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ipv4": {
"enabled": true
},
"ipv6": {
"enabled": true
}
}
],
"properties": {
"ipv4": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The ipv4 Schema",
"type": "object"
},
"ipv6": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The ipv6 Schema",
"type": "object"
}
},
"required": [],
"title": "The ipFamily Schema",
"type": "object"
},
"jobservice": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:31935f48613fef7c148b9abbcd578744f56052d59b1410ee20989467a45118a8",
"repository": "harbor/harbor-jobservice"
},
"jobLoggers": [
"file"
],
"loggerSweeperDuration": 14,
"maxJobWorkers": 10,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:31935f48613fef7c148b9abbcd578744f56052d59b1410ee20989467a45118a8",
"repository": "harbor/harbor-jobservice"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:31935f48613fef7c148b9abbcd578744f56052d59b1410ee20989467a45118a8"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-jobservice",
"examples": [
"harbor/harbor-jobservice"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"jobLoggers": {
"default": [],
"examples": [
[
"file"
]
],
"items": {
"default": "file",
"examples": [
"file"
],
"title": "A Schema",
"type": "string"
},
"title": "The jobLoggers Schema",
"type": "array"
},
"loggerSweeperDuration": {
"default": 14,
"examples": [
14
],
"title": "The loggerSweeperDuration Schema",
"type": "integer"
},
"maxJobWorkers": {
"default": 10,
"examples": [
10
],
"title": "The maxJobWorkers Schema",
"type": "integer"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The jobservice Schema",
"type": "object"
},
"logLevel": {
"default": "info",
"examples": [
"info"
],
"title": "The logLevel Schema",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"default": {},
"examples": [
{
"core": {
"path": "/metrics",
"port": 8001
},
"enabled": false,
"exporter": {
"path": "/metrics",
"port": 8001
},
"jobservice": {
"path": "/metrics",
"port": 8001
},
"registry": {
"path": "/metrics",
"port": 8001
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
}
],
"properties": {
"core": {
"additionalProperties": false,
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The core Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"exporter": {
"additionalProperties": false,
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The exporter Schema",
"type": "object"
},
"jobservice": {
"additionalProperties": false,
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The jobservice Schema",
"type": "object"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
],
"properties": {
"additionalLabels": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "",
"examples": [
""
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The metricRelabelings Schema",
"type": "array"
},
"relabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The relabelings Schema",
"type": "array"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
}
},
"required": [],
"title": "The metrics Schema",
"type": "object"
},
"nginx": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:9854ecee686c3ff4868f90bab75d232b057a683168e1852df9f3fca33bfefa7d",
"repository": "harbor/harbor-nginx"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:9854ecee686c3ff4868f90bab75d232b057a683168e1852df9f3fca33bfefa7d",
"repository": "harbor/harbor-nginx"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:9854ecee686c3ff4868f90bab75d232b057a683168e1852df9f3fca33bfefa7d"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-nginx",
"examples": [
"harbor/harbor-nginx"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The nginx Schema",
"type": "object"
},
"notary": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false,
"secretName": "",
"server": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
},
"signer": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"server": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-notary-server",
"examples": [
"harbor/harbor-notary-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The server Schema",
"type": "object"
},
"signer": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-notary-signer",
"examples": [
"harbor/harbor-notary-signer"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The signer Schema",
"type": "object"
}
},
"required": [],
"title": "The notary Schema",
"type": "object"
},
"persistence": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"imageChartStorage": {
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
},
"persistentVolumeClaim": {
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
},
"resourcePolicy": "keep"
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"imageChartStorage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
}
],
"properties": {
"azure": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
}
],
"properties": {
"accountkey": {
"default": "base64encodedaccountkey",
"examples": [
"base64encodedaccountkey"
],
"title": "The accountkey Schema",
"type": "string"
},
"accountname": {
"default": "accountname",
"examples": [
"accountname"
],
"title": "The accountname Schema",
"type": "string"
},
"container": {
"default": "containername",
"examples": [
"containername"
],
"title": "The container Schema",
"type": "string"
}
},
"required": [],
"title": "The azure Schema",
"type": "object"
},
"disableredirect": {
"default": false,
"examples": [
false
],
"title": "The disableredirect Schema",
"type": "boolean"
},
"filesystem": {
"additionalProperties": false,
"default": {},
"examples": [
{
"rootdirectory": "/storage"
}
],
"properties": {
"rootdirectory": {
"default": "/storage",
"examples": [
"/storage"
],
"title": "The rootdirectory Schema",
"type": "string"
}
},
"required": [],
"title": "The filesystem Schema",
"type": "object"
},
"gcs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
}
],
"properties": {
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"encodedkey": {
"default": "base64-encoded-json-key-file",
"examples": [
"base64-encoded-json-key-file"
],
"title": "The encodedkey Schema",
"type": "string"
}
},
"required": [],
"title": "The gcs Schema",
"type": "object"
},
"oss": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
}
],
"properties": {
"accesskeyid": {
"default": "accesskeyid",
"examples": [
"accesskeyid"
],
"title": "The accesskeyid Schema",
"type": "string"
},
"accesskeysecret": {
"default": "accesskeysecret",
"examples": [
"accesskeysecret"
],
"title": "The accesskeysecret Schema",
"type": "string"
},
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"region": {
"default": "regionname",
"examples": [
"regionname"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [],
"title": "The oss Schema",
"type": "object"
},
"s3": {
"additionalProperties": false,
"default": {},
"examples": [
{
"bucket": "bucketname",
"region": "us-west-1"
}
],
"properties": {
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"region": {
"default": "us-west-1",
"examples": [
"us-west-1"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [],
"title": "The s3 Schema",
"type": "object"
},
"swift": {
"additionalProperties": false,
"default": {},
"examples": [
{
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
}
],
"properties": {
"authurl": {
"default": "https://storage.myprovider.com/v3/auth",
"examples": [
"https://storage.myprovider.com/v3/auth"
],
"title": "The authurl Schema",
"type": "string"
},
"container": {
"default": "containername",
"examples": [
"containername"
],
"title": "The container Schema",
"type": "string"
},
"password": {
"default": "password",
"examples": [
"password"
],
"title": "The password Schema",
"type": "string"
},
"username": {
"default": "username",
"examples": [
"username"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [],
"title": "The swift Schema",
"type": "object"
},
"type": {
"default": "filesystem",
"examples": [
"filesystem"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The imageChartStorage Schema",
"type": "object"
},
"persistentVolumeClaim": {
"additionalProperties": false,
"default": {},
"examples": [
{
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
}
],
"properties": {
"chartmuseum": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The chartmuseum Schema",
"type": "object"
},
"database": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The database Schema",
"type": "object"
},
"jobservice": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The jobservice Schema",
"type": "object"
},
"redis": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The redis Schema",
"type": "object"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"trivy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The trivy Schema",
"type": "object"
}
},
"required": [],
"title": "The persistentVolumeClaim Schema",
"type": "object"
},
"resourcePolicy": {
"default": "keep",
"examples": [
"keep"
],
"title": "The resourcePolicy Schema",
"type": "string"
}
},
"required": [],
"title": "The persistence Schema",
"type": "object"
},
"portal": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:0256993eb356948ba2dfd6e969d2f8da903b849a25a31010a7250931c4d694e5",
"repository": "harbor/harbor-portal"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:0256993eb356948ba2dfd6e969d2f8da903b849a25a31010a7250931c4d694e5",
"repository": "harbor/harbor-portal"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:0256993eb356948ba2dfd6e969d2f8da903b849a25a31010a7250931c4d694e5"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-portal",
"examples": [
"harbor/harbor-portal"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The portal Schema",
"type": "object"
},
"proxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"components": [
"core",
"jobservice",
"trivy"
],
"httpProxy": null,
"httpsProxy": null,
"noProxy": "127.0.0.1,localhost,.local,.internal"
}
],
"properties": {
"components": {
"default": [],
"examples": [
[
"core",
"jobservice",
"trivy"
]
],
"items": {
"examples": [
"core",
"jobservice",
"trivy"
],
"title": "A Schema",
"type": "string"
},
"title": "The components Schema",
"type": "array"
},
"httpProxy": {
"default": null,
"examples": [
null
],
"title": "The httpProxy Schema",
"type": "null"
},
"httpsProxy": {
"default": null,
"examples": [
null
],
"title": "The httpsProxy Schema",
"type": "null"
},
"noProxy": {
"default": "127.0.0.1,localhost,.local,.internal",
"examples": [
"127.0.0.1,localhost,.local,.internal"
],
"title": "The noProxy Schema",
"type": "string"
}
},
"required": [],
"title": "The proxy Schema",
"type": "object"
},
"redis": {
"additionalProperties": false,
"default": {},
"examples": [
{
"external": {
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
},
"podAnnotations": {},
"type": "internal"
}
],
"properties": {
"external": {
"additionalProperties": false,
"default": {},
"examples": [
{
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
}
],
"properties": {
"addr": {
"default": "192.168.0.2:6379",
"examples": [
"192.168.0.2:6379"
],
"title": "The addr Schema",
"type": "string"
},
"chartmuseumDatabaseIndex": {
"default": "3",
"examples": [
"3"
],
"title": "The chartmuseumDatabaseIndex Schema",
"type": "string"
},
"coreDatabaseIndex": {
"default": "0",
"examples": [
"0"
],
"title": "The coreDatabaseIndex Schema",
"type": "string"
},
"jobserviceDatabaseIndex": {
"default": "1",
"examples": [
"1"
],
"title": "The jobserviceDatabaseIndex Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
""
],
"title": "The password Schema",
"type": "string"
},
"registryDatabaseIndex": {
"default": "2",
"examples": [
"2"
],
"title": "The registryDatabaseIndex Schema",
"type": "string"
},
"sentinelMasterSet": {
"default": "",
"examples": [
""
],
"title": "The sentinelMasterSet Schema",
"type": "string"
},
"trivyAdapterIndex": {
"default": "5",
"examples": [
"5"
],
"title": "The trivyAdapterIndex Schema",
"type": "string"
}
},
"required": [],
"title": "The external Schema",
"type": "object"
},
"internal": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab",
"repository": "harbor/harbor-redis"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-redis",
"examples": [
"harbor/harbor-redis"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The internal Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"type": {
"default": "internal",
"examples": [
"internal"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The redis Schema",
"type": "object"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"controller": {
"image": {
"digest": "sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761",
"repository": "harbor/harbor-registryctl"
}
},
"credentials": {
"password": "harbor_registry_password",
"username": "harbor_registry_user"
},
"middleware": {
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"registry": {
"image": {
"digest": "sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3",
"repository": "harbor/harbor-registry"
}
},
"relativeurls": false,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": [],
"upload_purging": {
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"controller": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"digest": "sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761",
"repository": "harbor/harbor-registryctl"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761",
"repository": "harbor/harbor-registryctl"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-registryctl",
"examples": [
"harbor/harbor-registryctl"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
}
},
"required": [],
"title": "The controller Schema",
"type": "object"
},
"credentials": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": "harbor_registry_password",
"username": "harbor_registry_user"
}
],
"properties": {
"password": {
"default": "harbor_registry_password",
"examples": [
"harbor_registry_password"
],
"title": "The password Schema",
"type": "string"
},
"username": {
"default": "harbor_registry_user",
"examples": [
"harbor_registry_user"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [],
"title": "The credentials Schema",
"type": "object"
},
"middleware": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
}
],
"properties": {
"cloudFront": {
"additionalProperties": false,
"default": {},
"examples": [
{
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
}
],
"properties": {
"baseurl": {
"default": "example.cloudfront.net",
"examples": [
"example.cloudfront.net"
],
"title": "The baseurl Schema",
"type": "string"
},
"duration": {
"default": "3000s",
"examples": [
"3000s"
],
"title": "The duration Schema",
"type": "string"
},
"ipfilteredby": {
"default": "none",
"examples": [
"none"
],
"title": "The ipfilteredby Schema",
"type": "string"
},
"keypairid": {
"default": "KEYPAIRID",
"examples": [
"KEYPAIRID"
],
"title": "The keypairid Schema",
"type": "string"
},
"privateKeySecret": {
"default": "my-secret",
"examples": [
"my-secret"
],
"title": "The privateKeySecret Schema",
"type": "string"
}
},
"required": [],
"title": "The cloudFront Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"type": {
"default": "cloudFront",
"examples": [
"cloudFront"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The middleware Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"digest": "sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3",
"repository": "harbor/harbor-registry"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3",
"repository": "harbor/harbor-registry"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-registry",
"examples": [
"harbor/harbor-registry"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"relativeurls": {
"default": false,
"examples": [
false
],
"title": "The relativeurls Schema",
"type": "boolean"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"upload_purging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
],
"properties": {
"age": {
"default": "168h",
"examples": [
"168h"
],
"title": "The age Schema",
"type": "string"
},
"dryrun": {
"default": false,
"examples": [
false
],
"title": "The dryrun Schema",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "24h",
"examples": [
"24h"
],
"title": "The interval Schema",
"type": "string"
}
},
"required": [],
"title": "The upload_purging Schema",
"type": "object"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"secretKey": {
"default": "",
"examples": [
""
],
"title": "The secretKey Schema",
"type": "string"
},
"sourceRegistry": {
"default": "public.ecr.aws/eks-anywhere",
"examples": [
"public.ecr.aws/eks-anywhere"
],
"title": "The sourceRegistry Schema",
"type": "string"
},
"trace": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false,
"jaeger": {
"endpoint": "http://hostname:14268/api/traces"
},
"otel": {
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
},
"provider": "jaeger",
"sample_rate": 1
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"jaeger": {
"additionalProperties": false,
"default": {},
"examples": [
{
"endpoint": "http://hostname:14268/api/traces"
}
],
"properties": {
"endpoint": {
"default": "http://hostname:14268/api/traces",
"examples": [
"http://hostname:14268/api/traces"
],
"title": "The endpoint Schema",
"type": "string"
}
},
"required": [],
"title": "The jaeger Schema",
"type": "object"
},
"otel": {
"additionalProperties": false,
"default": {},
"examples": [
{
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
}
],
"properties": {
"compression": {
"default": false,
"examples": [
false
],
"title": "The compression Schema",
"type": "boolean"
},
"endpoint": {
"default": "hostname:4318",
"examples": [
"hostname:4318"
],
"title": "The endpoint Schema",
"type": "string"
},
"insecure": {
"default": true,
"examples": [
true
],
"title": "The insecure Schema",
"type": "boolean"
},
"timeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The timeout Schema",
"type": "string"
},
"url_path": {
"default": "/v1/traces",
"examples": [
"/v1/traces"
],
"title": "The url_path Schema",
"type": "string"
}
},
"required": [],
"title": "The otel Schema",
"type": "object"
},
"provider": {
"default": "jaeger",
"examples": [
"jaeger"
],
"title": "The provider Schema",
"type": "string"
},
"sample_rate": {
"default": 1,
"examples": [
1
],
"title": "The sample_rate Schema",
"type": "integer"
}
},
"required": [],
"title": "The trace Schema",
"type": "object"
},
"trivy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"debugMode": false,
"enabled": true,
"gitHubToken": "",
"ignoreUnfixed": false,
"image": {
"digest": "sha256:829fc3d40ba7423280ed8d7a51ea6345283fa35c21177998902f5b311f5be0be",
"repository": "harbor/harbor-trivy"
},
"insecure": false,
"nodeSelector": {},
"offlineScan": false,
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"resources": {
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
},
"serviceAccountName": "",
"severity": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"skipUpdate": false,
"timeout": "5m0s",
"tolerations": [],
"vulnType": "os,library"
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"debugMode": {
"default": false,
"examples": [
false
],
"title": "The debugMode Schema",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"gitHubToken": {
"default": "",
"examples": [
""
],
"title": "The gitHubToken Schema",
"type": "string"
},
"ignoreUnfixed": {
"default": false,
"examples": [
false
],
"title": "The ignoreUnfixed Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:829fc3d40ba7423280ed8d7a51ea6345283fa35c21177998902f5b311f5be0be",
"repository": "harbor/harbor-trivy"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:829fc3d40ba7423280ed8d7a51ea6345283fa35c21177998902f5b311f5be0be"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-trivy",
"examples": [
"harbor/harbor-trivy"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"insecure": {
"default": false,
"examples": [
false
],
"title": "The insecure Schema",
"type": "boolean"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"offlineScan": {
"default": false,
"examples": [
false
],
"title": "The offlineScan Schema",
"type": "boolean"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": 1,
"memory": "1Gi"
}
],
"properties": {
"cpu": {
"default": 1,
"examples": [
1
],
"title": "The cpu Schema",
"type": "integer"
},
"memory": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "200m",
"memory": "512Mi"
}
],
"properties": {
"cpu": {
"default": "200m",
"examples": [
"200m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "512Mi",
"examples": [
"512Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The requests Schema",
"type": "object"
}
},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"severity": {
"default": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"examples": [
"UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL"
],
"title": "The severity Schema",
"type": "string"
},
"skipUpdate": {
"default": false,
"examples": [
false
],
"title": "The skipUpdate Schema",
"type": "boolean"
},
"timeout": {
"default": "5m0s",
"examples": [
"5m0s"
],
"title": "The timeout Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"vulnType": {
"default": "os,library",
"examples": [
"os,library"
],
"title": "The vulnType Schema",
"type": "string"
}
},
"required": [],
"title": "The trivy Schema",
"type": "object"
},
"updateStrategy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"type": "Recreate"
}
],
"properties": {
"type": {
"default": "Recreate",
"examples": [
"Recreate"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"required": [
"secretKey"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 64cffc5a869c8189d488160d803e6793edd792b2 | 2024-01-18T18:42:35 | projects/kubernetes-sigs/metrics-server/1-28/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "Annotations to add to the APIService",
"type": "object"
},
"caBundle": {
"default": "",
"examples": [
""
],
"title": "PEM encoded CA bundle for TLS verification",
"type": "string"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"insecureSkipTLSVerify": {
"default": true,
"examples": [
true
],
"title": "Specifies whether to skip TLS verification",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"commonLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The commonLabels Schema",
"type": "object"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"securityContext": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 10250,
"examples": [
10250
],
"title": "The containerPort Schema",
"type": "integer"
},
"default": {},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"drop": {
"default": [
"ALL"
],
"examples": [
[]
],
"items": {},
"title": "The drop Schema",
"type": "array"
}
},
"required": [],
"title": "The seccompProfile Schema",
"type": "object"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
},
"seccompProfile": {
"default": {},
"examples": [
{}
],
"properties": {
"type": {
"default": "RuntimeDefault",
"examples": [
"RuntimeDefault"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The seccompProfile Schema",
"type": "object"
}
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"required": [],
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"schedulerName": {
"default": "",
"examples": [],
"title": "The schedulerName Schema",
"type": "string"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The metricRelabelings Schema",
"type": "array"
},
"relabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The relabelings Schema",
"type": "array"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"title": "The securityContext Schema",
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"type": "object",
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
},
"secrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The list of secrets mountable by this service account",
"type": "array"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 18810e346a3bb7fdbea7a75640c21547a57d2a1f | 2023-02-09T23:37:00 | projects/kubernetes-sigs/metrics-server/1-26/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 4443,
"examples": [
4443
],
"title": "The containerPort Schema",
"type": "integer"
},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | e53b05219ea2000162b1c3efa5bed53be91c633a | 2023-08-25T00:09:25 | projects/kubernetes/autoscaler/1-28/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"additionalLabels": {},
"affinity": {},
"autoDiscovery": {
"clusterName": "my-cluster",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
},
"autoscalingGroups": [],
"autoscalingGroupsnamePrefix": [],
"awsAccessKeyID": "",
"awsRegion": "us-east-1",
"awsSecretAccessKey": "",
"azureClientID": "",
"azureClientSecret": "",
"azureClusterName": "",
"azureNodeResourceGroup": "",
"azureResourceGroup": "",
"azureSubscriptionID": "",
"azureTenantID": "",
"azureUseManagedIdentityExtension": false,
"azureVMType": "AKS",
"cloudConfigPath": "",
"cloudProvider": "clusterapi",
"clusterAPICloudConfigPath": "/etc/kubernetes/mgmt-kubeconfig",
"clusterAPIConfigMapsNamespace": "",
"clusterAPIKubeconfigSecret": "",
"clusterAPIMode": "incluster-incluster",
"clusterAPIWorkloadKubeconfigPath": "/etc/kubernetes/value",
"containerSecurityContext": {},
"deployment": {
"annotations": {}
},
"dnsPolicy": "ClusterFirst",
"envFromConfigMap": "",
"envFromSecret": "",
"expanderPriorities": {},
"extraArgs": {
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
},
"extraEnv": {},
"extraEnvConfigMaps": {},
"extraEnvSecrets": {},
"extraVolumeMounts": [],
"extraVolumeSecrets": {},
"extraVolumes": [],
"fullnameOverride": "",
"image": {
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
},
"imagePullSecrets": [],
"kubeTargetVersionOverride": "",
"magnumCABundlePath": "/etc/kubernetes/ca-bundle.crt",
"magnumClusterName": "",
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"maxUnavailable": 1
},
"podLabels": {},
"priorityClassName": "system-cluster-critical",
"priorityConfigMapAnnotations": {},
"prometheusRule": {
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
},
"rbac": {
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
},
"replicaCount": 1,
"resources": {},
"securityContext": {},
"service": {
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
},
"sourceRegistry": "public.ecr.aws",
"tolerations": [],
"topologySpreadConstraints": [],
"updateStrategy": {}
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"autoDiscovery": {
"default": {},
"examples": [
{
"clusterName": "my-cluster-name",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
}
],
"properties": {
"clusterName": {
"default": "",
"examples": [
"my-cluster-name"
],
"title": "The clusterName Schema",
"type": "string"
},
"labels": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The labels Schema",
"type": "array"
},
"roles": {
"default": [],
"examples": [
[
"worker"
]
],
"items": {
"default": "",
"examples": [
"worker"
],
"title": "A Schema",
"type": "string"
},
"title": "The roles Schema",
"type": "array"
},
"tags": {
"default": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"examples": [
[
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
],
"items": {
"examples": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"title": "A Schema",
"type": "string"
},
"title": "The tags Schema",
"type": "array"
}
},
"required": [],
"title": "The autoDiscovery Schema",
"type": "object"
},
"autoscalingGroups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroups Schema",
"type": "array"
},
"autoscalingGroupsnamePrefix": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroupsnamePrefix Schema",
"type": "array"
},
"awsAccessKeyID": {
"default": "",
"examples": [
""
],
"title": "The awsAccessKeyID Schema",
"type": "string"
},
"awsRegion": {
"default": "",
"examples": [
"us-east-1"
],
"title": "The awsRegion Schema",
"type": "string"
},
"awsSecretAccessKey": {
"default": "",
"examples": [
""
],
"title": "The awsSecretAccessKey Schema",
"type": "string"
},
"azureClientID": {
"default": "",
"examples": [
""
],
"title": "The azureClientID Schema",
"type": "string"
},
"azureClientSecret": {
"default": "",
"examples": [
""
],
"title": "The azureClientSecret Schema",
"type": "string"
},
"azureClusterName": {
"default": "",
"examples": [
""
],
"title": "The azureClusterName Schema",
"type": "string"
},
"azureNodeResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureNodeResourceGroup Schema",
"type": "string"
},
"azureResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureResourceGroup Schema",
"type": "string"
},
"azureSubscriptionID": {
"default": "",
"examples": [
""
],
"title": "The azureSubscriptionID Schema",
"type": "string"
},
"azureTenantID": {
"default": "",
"examples": [
""
],
"title": "The azureTenantID Schema",
"type": "string"
},
"azureUseManagedIdentityExtension": {
"default": false,
"examples": [
false
],
"title": "The azureUseManagedIdentityExtension Schema",
"type": "boolean"
},
"azureVMType": {
"default": "",
"examples": [
"AKS"
],
"title": "The azureVMType Schema",
"type": "string"
},
"cloudConfigPath": {
"default": "",
"examples": [
""
],
"title": "The cloudConfigPath Schema",
"type": "string"
},
"cloudProvider": {
"default": "",
"examples": [
"clusterapi"
],
"title": "The cloudProvider Schema",
"type": "string"
},
"clusterAPICloudConfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/mgmt-kubeconfig"
],
"title": "The clusterAPICloudConfigPath Schema",
"type": "string"
},
"clusterAPIConfigMapsNamespace": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIConfigMapsNamespace Schema",
"type": "string"
},
"clusterAPIKubeconfigSecret": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIKubeconfigSecret Schema",
"type": "string"
},
"clusterAPIMode": {
"default": "",
"examples": [
"incluster-incluster"
],
"title": "The clusterAPIMode Schema",
"type": "string"
},
"clusterAPIWorkloadKubeconfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/value"
],
"title": "The clusterAPIWorkloadKubeconfigPath Schema",
"type": "string"
},
"containerSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The containerSecurityContext Schema",
"type": "object"
},
"deployment": {
"default": {},
"examples": [
{
"annotations": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
}
},
"required": [
"annotations"
],
"title": "The deployment Schema",
"type": "object"
},
"dnsPolicy": {
"default": "",
"examples": [
"ClusterFirst"
],
"title": "The dnsPolicy Schema",
"type": "string"
},
"envFromConfigMap": {
"default": "",
"examples": [
""
],
"title": "The envFromConfigMap Schema",
"type": "string"
},
"envFromSecret": {
"default": "",
"examples": [
""
],
"title": "The envFromSecret Schema",
"type": "string"
},
"expanderPriorities": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The expanderPriorities Schema",
"type": "object"
},
"extraArgs": {
"default": {},
"examples": [
{
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
}
],
"properties": {
"logtostderr": {
"default": true,
"examples": [
true
],
"title": "The logtostderr Schema",
"type": "boolean"
},
"stderrthreshold": {
"default": "info",
"examples": [
"info"
],
"title": "The stderrthreshold Schema",
"type": "string"
},
"v": {
"default": 4,
"examples": [
4
],
"title": "The v Schema",
"type": "integer"
}
},
"required": [],
"title": "The extraArgs Schema",
"type": "object"
},
"extraEnv": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnv Schema",
"type": "object"
},
"extraEnvConfigMaps": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvConfigMaps Schema",
"type": "object"
},
"extraEnvSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvSecrets Schema",
"type": "object"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumeSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraVolumeSecrets Schema",
"type": "object"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "kubernetes/autoscaler",
"examples": [
"kubernetes/autoscaler"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeTargetVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeTargetVersionOverride Schema",
"type": "string"
},
"magnumCABundlePath": {
"default": "",
"examples": [
"/etc/kubernetes/ca-bundle.crt"
],
"title": "The magnumCABundlePath Schema",
"type": "string"
},
"magnumClusterName": {
"default": "",
"examples": [
""
],
"title": "The magnumClusterName Schema",
"type": "string"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"maxUnavailable": 1
}
],
"properties": {
"maxUnavailable": {
"default": 1,
"examples": [
1
],
"title": "The maxUnavailable Schema",
"type": "integer"
}
},
"required": [
"maxUnavailable"
],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"priorityConfigMapAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The priorityConfigMapAnnotations Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"rules": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The rules Schema",
"type": "array"
}
},
"required": [],
"title": "The prometheusRule Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
}
],
"properties": {
"clusterScoped": {
"default": true,
"examples": [
true
],
"title": "The clusterScoped Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"externalIPs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The externalIPs Schema",
"type": "array"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"loadBalancerIP": {
"default": "",
"examples": [
""
],
"title": "The loadBalancerIP Schema",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The loadBalancerSourceRanges Schema",
"type": "array"
},
"portName": {
"default": "http",
"examples": [
"http"
],
"title": "The portName Schema",
"type": "string"
},
"servicePort": {
"default": 8085,
"examples": [
8085
],
"title": "The servicePort Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The metricRelabelings Schema",
"type": "object"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"selector": {
"default": {},
"examples": [
{
"release": "prometheus-operator"
}
],
"properties": {
"release": {
"default": "prometheus-operator",
"examples": [
"prometheus-operator"
],
"title": "The release Schema",
"type": "string"
}
},
"required": [],
"title": "The selector Schema",
"type": "object"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | d76698192b9d4c3d2304a1620fc8885adb4e9332 | 2022-08-02T22:50:31 | projects/goharbor/harbor/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"caSecretName": "",
"chartmuseum": {
"absoluteUrl": false,
"affinity": {},
"automountServiceAccountToken": false,
"enabled": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
},
"indexLimit": 0,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"core": {
"affinity": {},
"artifactPullAsyncFlushDuration": null,
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7ae78dc49fa911872ab4a4e63e82645c442fc7a4eece4047701a18cf2849d076",
"repository": "harbor/harbor-core"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"secretName": "",
"serviceAccountName": "",
"startupProbe": {
"enabled": true,
"initialDelaySeconds": 10
},
"tolerations": [],
"xsrfKey": ""
},
"database": {
"external": {
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
},
"maxIdleConns": 100,
"maxOpenConns": 900,
"podAnnotations": {},
"type": "internal"
},
"enableMigrateHelmHook": false,
"exporter": {
"affinity": {},
"automountServiceAccountToken": false,
"cacheCleanInterval": 14400,
"cacheDuration": 23,
"image": {
"digest": "sha256:b094bdbb1248bab4a845a512a7aebc0de3b63724b15a0bd5bf03eadbb9c7e73b",
"repository": "harbor/harbor-exporter"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"expose": {
"clusterIP": {
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
},
"ingress": {
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
},
"loadBalancer": {
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
},
"nodePort": {
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
},
"tls": {
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
},
"type": "nodePort"
},
"externalURL": "https://127.0.0.1:30003",
"harborAdminPassword": "Harbor12345",
"imagePullPolicy": "IfNotPresent",
"imagePullSecrets": null,
"internalTLS": {
"certSource": "auto",
"chartmuseum": {
"crt": "",
"key": "",
"secretName": ""
},
"core": {
"crt": "",
"key": "",
"secretName": ""
},
"enabled": true,
"jobservice": {
"crt": "",
"key": "",
"secretName": ""
},
"portal": {
"crt": "",
"key": "",
"secretName": ""
},
"registry": {
"crt": "",
"key": "",
"secretName": ""
},
"trivy": {
"crt": "",
"key": "",
"secretName": ""
},
"trustCa": ""
},
"ipFamily": {
"ipv4": {
"enabled": true
},
"ipv6": {
"enabled": true
}
},
"jobservice": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:31935f48613fef7c148b9abbcd578744f56052d59b1410ee20989467a45118a8",
"repository": "harbor/harbor-jobservice"
},
"jobLoggers": [
"file"
],
"loggerSweeperDuration": 14,
"maxJobWorkers": 10,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": []
},
"logLevel": "info",
"metrics": {
"core": {
"path": "/metrics",
"port": 8001
},
"enabled": false,
"exporter": {
"path": "/metrics",
"port": 8001
},
"jobservice": {
"path": "/metrics",
"port": 8001
},
"registry": {
"path": "/metrics",
"port": 8001
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
},
"nginx": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:9854ecee686c3ff4868f90bab75d232b057a683168e1852df9f3fca33bfefa7d",
"repository": "harbor/harbor-nginx"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"notary": {
"enabled": false,
"secretName": "",
"server": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
},
"signer": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
},
"persistence": {
"enabled": true,
"imageChartStorage": {
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
},
"persistentVolumeClaim": {
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
},
"resourcePolicy": "keep"
},
"portal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:0256993eb356948ba2dfd6e969d2f8da903b849a25a31010a7250931c4d694e5",
"repository": "harbor/harbor-portal"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"proxy": {
"components": [
"core",
"jobservice",
"trivy"
],
"httpProxy": null,
"httpsProxy": null,
"noProxy": "127.0.0.1,localhost,.local,.internal"
},
"redis": {
"external": {
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
},
"podAnnotations": {},
"type": "internal"
},
"registry": {
"affinity": {},
"automountServiceAccountToken": false,
"controller": {
"image": {
"digest": "sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761",
"repository": "harbor/harbor-registryctl"
}
},
"credentials": {
"password": "harbor_registry_password",
"username": "harbor_registry_user"
},
"middleware": {
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"registry": {
"image": {
"digest": "sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3",
"repository": "harbor/harbor-registry"
}
},
"relativeurls": false,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": [],
"upload_purging": {
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
},
"secretKey": "",
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"trace": {
"enabled": false,
"jaeger": {
"endpoint": "http://hostname:14268/api/traces"
},
"otel": {
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
},
"provider": "jaeger",
"sample_rate": 1
},
"trivy": {
"affinity": {},
"automountServiceAccountToken": false,
"debugMode": false,
"enabled": true,
"gitHubToken": "",
"ignoreUnfixed": false,
"image": {
"digest": "sha256:829fc3d40ba7423280ed8d7a51ea6345283fa35c21177998902f5b311f5be0be",
"repository": "harbor/harbor-trivy"
},
"insecure": false,
"nodeSelector": {},
"offlineScan": false,
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"resources": {
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
},
"serviceAccountName": "",
"severity": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"skipUpdate": false,
"timeout": "5m0s",
"tolerations": [],
"vulnType": "os,library"
},
"updateStrategy": {
"type": "Recreate"
}
}
],
"properties": {
"caSecretName": {
"default": "",
"examples": [
""
],
"title": "The caSecretName Schema",
"type": "string"
},
"chartmuseum": {
"default": {},
"examples": [
{
"absoluteUrl": false,
"affinity": {},
"automountServiceAccountToken": false,
"enabled": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
},
"indexLimit": 0,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"absoluteUrl": {
"default": false,
"examples": [
false
],
"title": "The absoluteUrl Schema",
"type": "boolean"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-chartmuseum",
"examples": [
"harbor/harbor-chartmuseum"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"indexLimit": {
"default": 0,
"examples": [
0
],
"title": "The indexLimit Schema",
"type": "integer"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"enabled",
"serviceAccountName",
"automountServiceAccountToken",
"absoluteUrl",
"image",
"replicas",
"revisionHistoryLimit",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName",
"indexLimit"
],
"title": "The chartmuseum Schema",
"type": "object"
},
"core": {
"default": {},
"examples": [
{
"affinity": {},
"artifactPullAsyncFlushDuration": null,
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7ae78dc49fa911872ab4a4e63e82645c442fc7a4eece4047701a18cf2849d076",
"repository": "harbor/harbor-core"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"secretName": "",
"serviceAccountName": "",
"startupProbe": {
"enabled": true,
"initialDelaySeconds": 10
},
"tolerations": [],
"xsrfKey": ""
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"artifactPullAsyncFlushDuration": {
"default": null,
"examples": [
null
],
"title": "The artifactPullAsyncFlushDuration Schema",
"type": "null"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:7ae78dc49fa911872ab4a4e63e82645c442fc7a4eece4047701a18cf2849d076",
"repository": "harbor/harbor-core"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7ae78dc49fa911872ab4a4e63e82645c442fc7a4eece4047701a18cf2849d076"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-core",
"examples": [
"harbor/harbor-core"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"startupProbe": {
"default": {},
"examples": [
{
"enabled": true,
"initialDelaySeconds": 10
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"initialDelaySeconds": {
"default": 10,
"examples": [
10
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
}
},
"required": [
"enabled",
"initialDelaySeconds"
],
"title": "The startupProbe Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"xsrfKey": {
"default": "",
"examples": [
""
],
"title": "The xsrfKey Schema",
"type": "string"
}
},
"required": [
"image",
"serviceAccountName",
"automountServiceAccountToken",
"replicas",
"revisionHistoryLimit",
"startupProbe",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"secret",
"secretName",
"xsrfKey",
"priorityClassName",
"artifactPullAsyncFlushDuration"
],
"title": "The core Schema",
"type": "object"
},
"database": {
"default": {},
"examples": [
{
"external": {
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
},
"maxIdleConns": 100,
"maxOpenConns": 900,
"podAnnotations": {},
"type": "internal"
}
],
"properties": {
"external": {
"default": {},
"examples": [
{
"coreDatabase": "registry",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
}
],
"properties": {
"coreDatabase": {
"default": "registry",
"examples": [
"registry"
],
"title": "The coreDatabase Schema",
"type": "string"
},
"host": {
"default": "192.168.0.1",
"examples": [
"192.168.0.1"
],
"title": "The host Schema",
"type": "string"
},
"notaryServerDatabase": {
"default": "notary_server",
"examples": [
"notary_server"
],
"title": "The notaryServerDatabase Schema",
"type": "string"
},
"notarySignerDatabase": {
"default": "notary_signer",
"examples": [
"notary_signer"
],
"title": "The notarySignerDatabase Schema",
"type": "string"
},
"password": {
"default": "password",
"examples": [
"password"
],
"title": "The password Schema",
"type": "string"
},
"port": {
"default": "5432",
"examples": [
"5432"
],
"title": "The port Schema",
"type": "string"
},
"sslmode": {
"default": "disable",
"examples": [
"disable"
],
"title": "The sslmode Schema",
"type": "string"
},
"username": {
"default": "user",
"examples": [
"user"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"host",
"port",
"username",
"password",
"coreDatabase",
"notaryServerDatabase",
"notarySignerDatabase",
"sslmode"
],
"title": "The external Schema",
"type": "object"
},
"internal": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5",
"repository": "harbor/harbor-db"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7b219f620243ae37a7f105787c298420033f3bea74719fa1446b6fb76b8db2c5"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-db",
"examples": [
"harbor/harbor-db"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"initContainer": {
"default": {},
"examples": [
{
"migrator": {},
"permissions": {}
}
],
"properties": {
"migrator": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The migrator Schema",
"type": "object"
},
"permissions": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The permissions Schema",
"type": "object"
}
},
"required": [
"migrator",
"permissions"
],
"title": "The initContainer Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"password": {
"default": "changeit",
"examples": [
"changeit"
],
"title": "The password Schema",
"type": "string"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"shmSizeLimit": {
"default": "512Mi",
"examples": [
"512Mi"
],
"title": "The shmSizeLimit Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"image",
"password",
"shmSizeLimit",
"nodeSelector",
"tolerations",
"affinity",
"priorityClassName",
"initContainer"
],
"title": "The internal Schema",
"type": "object"
},
"maxIdleConns": {
"default": 100,
"examples": [
100
],
"title": "The maxIdleConns Schema",
"type": "integer"
},
"maxOpenConns": {
"default": 900,
"examples": [
900
],
"title": "The maxOpenConns Schema",
"type": "integer"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"type": {
"default": "internal",
"examples": [
"internal"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"internal",
"external",
"maxIdleConns",
"maxOpenConns",
"podAnnotations"
],
"title": "The database Schema",
"type": "object"
},
"enableMigrateHelmHook": {
"default": false,
"examples": [
false
],
"title": "The enableMigrateHelmHook Schema",
"type": "boolean"
},
"exporter": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"cacheCleanInterval": 14400,
"cacheDuration": 23,
"image": {
"digest": "sha256:b094bdbb1248bab4a845a512a7aebc0de3b63724b15a0bd5bf03eadbb9c7e73b",
"repository": "harbor/harbor-exporter"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"cacheCleanInterval": {
"default": 14400,
"examples": [
14400
],
"title": "The cacheCleanInterval Schema",
"type": "integer"
},
"cacheDuration": {
"default": 23,
"examples": [
23
],
"title": "The cacheDuration Schema",
"type": "integer"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:b094bdbb1248bab4a845a512a7aebc0de3b63724b15a0bd5bf03eadbb9c7e73b",
"repository": "harbor/harbor-exporter"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:b094bdbb1248bab4a845a512a7aebc0de3b63724b15a0bd5bf03eadbb9c7e73b"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-exporter",
"examples": [
"harbor/harbor-exporter"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"replicas",
"revisionHistoryLimit",
"podAnnotations",
"serviceAccountName",
"automountServiceAccountToken",
"image",
"nodeSelector",
"tolerations",
"affinity",
"cacheDuration",
"cacheCleanInterval",
"priorityClassName"
],
"title": "The exporter Schema",
"type": "object"
},
"expose": {
"default": {},
"examples": [
{
"clusterIP": {
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
},
"ingress": {
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
},
"loadBalancer": {
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
},
"nodePort": {
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
},
"tls": {
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
},
"type": "nodePort"
}
],
"properties": {
"clusterIP": {
"default": {},
"examples": [
{
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"default": {},
"examples": [
{
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
],
"properties": {
"httpPort": {
"default": 80,
"examples": [
80
],
"title": "The httpPort Schema",
"type": "integer"
},
"httpsPort": {
"default": 443,
"examples": [
443
],
"title": "The httpsPort Schema",
"type": "integer"
},
"notaryPort": {
"default": 4443,
"examples": [
4443
],
"title": "The notaryPort Schema",
"type": "integer"
}
},
"required": [
"httpPort",
"httpsPort",
"notaryPort"
],
"title": "The ports Schema",
"type": "object"
}
},
"required": [
"name",
"annotations",
"ports"
],
"title": "The clusterIP Schema",
"type": "object"
},
"ingress": {
"default": {},
"examples": [
{
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
}
],
"properties": {
"ingress.kubernetes.io/proxy-body-size": {
"default": "0",
"examples": [
"0"
],
"title": "The ingress.kubernetes.io/proxy-body-size Schema",
"type": "string"
},
"ingress.kubernetes.io/ssl-redirect": {
"default": "true",
"examples": [
"true"
],
"title": "The ingress.kubernetes.io/ssl-redirect Schema",
"type": "string"
},
"nginx.ingress.kubernetes.io/proxy-body-size": {
"default": "0",
"examples": [
"0"
],
"title": "The nginx.ingress.kubernetes.io/proxy-body-size Schema",
"type": "string"
},
"nginx.ingress.kubernetes.io/ssl-redirect": {
"default": "true",
"examples": [
"true"
],
"title": "The nginx.ingress.kubernetes.io/ssl-redirect Schema",
"type": "string"
}
},
"required": [
"ingress.kubernetes.io/ssl-redirect",
"ingress.kubernetes.io/proxy-body-size",
"nginx.ingress.kubernetes.io/ssl-redirect",
"nginx.ingress.kubernetes.io/proxy-body-size"
],
"title": "The annotations Schema",
"type": "object"
},
"className": {
"default": "",
"examples": [
""
],
"title": "The className Schema",
"type": "string"
},
"controller": {
"default": "default",
"examples": [
"default"
],
"title": "The controller Schema",
"type": "string"
},
"harbor": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
}
},
"required": [
"annotations",
"labels"
],
"title": "The harbor Schema",
"type": "object"
},
"hosts": {
"default": {},
"examples": [
{
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
}
],
"properties": {
"core": {
"default": "core.harbor.domain",
"examples": [
"core.harbor.domain"
],
"title": "The core Schema",
"type": "string"
},
"notary": {
"default": "notary.harbor.domain",
"examples": [
"notary.harbor.domain"
],
"title": "The notary Schema",
"type": "string"
}
},
"required": [
"core",
"notary"
],
"title": "The hosts Schema",
"type": "object"
},
"kubeVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeVersionOverride Schema",
"type": "string"
},
"notary": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
}
},
"required": [
"annotations",
"labels"
],
"title": "The notary Schema",
"type": "object"
}
},
"required": [
"hosts",
"controller",
"kubeVersionOverride",
"className",
"annotations",
"notary",
"harbor"
],
"title": "The ingress Schema",
"type": "object"
},
"loadBalancer": {
"default": {},
"examples": [
{
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
}
],
"properties": {
"IP": {
"default": "",
"examples": [
""
],
"title": "The IP Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"default": {},
"examples": [
{
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
],
"properties": {
"httpPort": {
"default": 80,
"examples": [
80
],
"title": "The httpPort Schema",
"type": "integer"
},
"httpsPort": {
"default": 443,
"examples": [
443
],
"title": "The httpsPort Schema",
"type": "integer"
},
"notaryPort": {
"default": 4443,
"examples": [
4443
],
"title": "The notaryPort Schema",
"type": "integer"
}
},
"required": [
"httpPort",
"httpsPort",
"notaryPort"
],
"title": "The ports Schema",
"type": "object"
},
"sourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The sourceRanges Schema",
"type": "array"
}
},
"required": [
"name",
"IP",
"ports",
"annotations",
"sourceRanges"
],
"title": "The loadBalancer Schema",
"type": "object"
},
"nodePort": {
"default": {},
"examples": [
{
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
}
],
"properties": {
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"default": {},
"examples": [
{
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
],
"properties": {
"http": {
"default": {},
"examples": [
{
"nodePort": 30002,
"port": 80
}
],
"properties": {
"nodePort": {
"default": 30002,
"examples": [
30002
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 80,
"examples": [
80
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"port",
"nodePort"
],
"title": "The http Schema",
"type": "object"
},
"https": {
"default": {},
"examples": [
{
"nodePort": 30003,
"port": 443
}
],
"properties": {
"nodePort": {
"default": 30003,
"examples": [
30003
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"port",
"nodePort"
],
"title": "The https Schema",
"type": "object"
},
"notary": {
"default": {},
"examples": [
{
"nodePort": 30004,
"port": 4443
}
],
"properties": {
"nodePort": {
"default": 30004,
"examples": [
30004
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 4443,
"examples": [
4443
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"port",
"nodePort"
],
"title": "The notary Schema",
"type": "object"
}
},
"required": [
"http",
"https",
"notary"
],
"title": "The ports Schema",
"type": "object"
}
},
"required": [
"name",
"ports"
],
"title": "The nodePort Schema",
"type": "object"
},
"tls": {
"default": {},
"examples": [
{
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
}
],
"properties": {
"auto": {
"default": {},
"examples": [
{
"commonName": ""
}
],
"properties": {
"commonName": {
"default": "",
"examples": [
""
],
"title": "The commonName Schema",
"type": "string"
}
},
"required": [
"commonName"
],
"title": "The auto Schema",
"type": "object"
},
"certSource": {
"default": "secret",
"examples": [
"secret"
],
"title": "The certSource Schema",
"type": "string"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"secret": {
"default": {},
"examples": [
{
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
],
"properties": {
"notarySecretName": {
"default": "",
"examples": [
""
],
"title": "The notarySecretName Schema",
"type": "string"
},
"secretName": {
"default": "harbor-tls-secret",
"examples": [
"harbor-tls-secret"
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"notarySecretName"
],
"title": "The secret Schema",
"type": "object"
}
},
"required": [
"enabled",
"certSource",
"auto",
"secret"
],
"title": "The tls Schema",
"type": "object"
},
"type": {
"default": "nodePort",
"examples": [
"nodePort"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"tls",
"ingress",
"clusterIP",
"nodePort",
"loadBalancer"
],
"title": "The expose Schema",
"type": "object"
},
"externalURL": {
"default": "https://127.0.0.1:30003",
"examples": [
"https://127.0.0.1:30003"
],
"title": "The externalURL Schema",
"type": "string"
},
"harborAdminPassword": {
"default": "Harbor12345",
"examples": [
"Harbor12345"
],
"title": "The harborAdminPassword Schema",
"type": "string"
},
"imagePullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The imagePullPolicy Schema",
"type": "string"
},
"imagePullSecrets": {
"default": null,
"examples": [
null
],
"title": "The imagePullSecrets Schema",
"type": "null"
},
"internalTLS": {
"default": {},
"examples": [
{
"certSource": "auto",
"chartmuseum": {
"crt": "",
"key": "",
"secretName": ""
},
"core": {
"crt": "",
"key": "",
"secretName": ""
},
"enabled": true,
"jobservice": {
"crt": "",
"key": "",
"secretName": ""
},
"portal": {
"crt": "",
"key": "",
"secretName": ""
},
"registry": {
"crt": "",
"key": "",
"secretName": ""
},
"trivy": {
"crt": "",
"key": "",
"secretName": ""
},
"trustCa": ""
}
],
"properties": {
"certSource": {
"default": "auto",
"examples": [
"auto"
],
"title": "The certSource Schema",
"type": "string"
},
"chartmuseum": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The chartmuseum Schema",
"type": "object"
},
"core": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The core Schema",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"jobservice": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The jobservice Schema",
"type": "object"
},
"portal": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The portal Schema",
"type": "object"
},
"registry": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The registry Schema",
"type": "object"
},
"trivy": {
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [
"secretName",
"crt",
"key"
],
"title": "The trivy Schema",
"type": "object"
},
"trustCa": {
"default": "",
"examples": [
""
],
"title": "The trustCa Schema",
"type": "string"
}
},
"required": [
"enabled",
"certSource",
"trustCa",
"core",
"jobservice",
"registry",
"portal",
"chartmuseum",
"trivy"
],
"title": "The internalTLS Schema",
"type": "object"
},
"ipFamily": {
"default": {},
"examples": [
{
"ipv4": {
"enabled": true
},
"ipv6": {
"enabled": true
}
}
],
"properties": {
"ipv4": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The ipv4 Schema",
"type": "object"
},
"ipv6": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The ipv6 Schema",
"type": "object"
}
},
"required": [
"ipv6",
"ipv4"
],
"title": "The ipFamily Schema",
"type": "object"
},
"jobservice": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:31935f48613fef7c148b9abbcd578744f56052d59b1410ee20989467a45118a8",
"repository": "harbor/harbor-jobservice"
},
"jobLoggers": [
"file"
],
"loggerSweeperDuration": 14,
"maxJobWorkers": 10,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:31935f48613fef7c148b9abbcd578744f56052d59b1410ee20989467a45118a8",
"repository": "harbor/harbor-jobservice"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:31935f48613fef7c148b9abbcd578744f56052d59b1410ee20989467a45118a8"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-jobservice",
"examples": [
"harbor/harbor-jobservice"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"jobLoggers": {
"default": [],
"examples": [
[
"file"
]
],
"items": {
"default": "file",
"examples": [
"file"
],
"title": "A Schema",
"type": "string"
},
"title": "The jobLoggers Schema",
"type": "array"
},
"loggerSweeperDuration": {
"default": 14,
"examples": [
14
],
"title": "The loggerSweeperDuration Schema",
"type": "integer"
},
"maxJobWorkers": {
"default": 10,
"examples": [
10
],
"title": "The maxJobWorkers Schema",
"type": "integer"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"replicas",
"revisionHistoryLimit",
"serviceAccountName",
"automountServiceAccountToken",
"maxJobWorkers",
"jobLoggers",
"loggerSweeperDuration",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"secret",
"priorityClassName"
],
"title": "The jobservice Schema",
"type": "object"
},
"logLevel": {
"default": "info",
"examples": [
"info"
],
"title": "The logLevel Schema",
"type": "string"
},
"metrics": {
"default": {},
"examples": [
{
"core": {
"path": "/metrics",
"port": 8001
},
"enabled": false,
"exporter": {
"path": "/metrics",
"port": 8001
},
"jobservice": {
"path": "/metrics",
"port": 8001
},
"registry": {
"path": "/metrics",
"port": 8001
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
}
],
"properties": {
"core": {
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"path",
"port"
],
"title": "The core Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"exporter": {
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"path",
"port"
],
"title": "The exporter Schema",
"type": "object"
},
"jobservice": {
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"path",
"port"
],
"title": "The jobservice Schema",
"type": "object"
},
"registry": {
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [
"path",
"port"
],
"title": "The registry Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "",
"examples": [
""
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The metricRelabelings Schema",
"type": "array"
},
"relabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The relabelings Schema",
"type": "array"
}
},
"required": [
"enabled",
"additionalLabels",
"interval",
"metricRelabelings",
"relabelings"
],
"title": "The serviceMonitor Schema",
"type": "object"
}
},
"required": [
"enabled",
"core",
"registry",
"jobservice",
"exporter",
"serviceMonitor"
],
"title": "The metrics Schema",
"type": "object"
},
"nginx": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:9854ecee686c3ff4868f90bab75d232b057a683168e1852df9f3fca33bfefa7d",
"repository": "harbor/harbor-nginx"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:9854ecee686c3ff4868f90bab75d232b057a683168e1852df9f3fca33bfefa7d",
"repository": "harbor/harbor-nginx"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:9854ecee686c3ff4868f90bab75d232b057a683168e1852df9f3fca33bfefa7d"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-nginx",
"examples": [
"harbor/harbor-nginx"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"serviceAccountName",
"automountServiceAccountToken",
"replicas",
"revisionHistoryLimit",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The nginx Schema",
"type": "object"
},
"notary": {
"default": {},
"examples": [
{
"enabled": false,
"secretName": "",
"server": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
},
"signer": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"server": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-notary-server",
"examples": [
"harbor/harbor-notary-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"image",
"replicas",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The server Schema",
"type": "object"
},
"signer": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-notary-signer",
"examples": [
"harbor/harbor-notary-signer"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"image",
"replicas",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The signer Schema",
"type": "object"
}
},
"required": [
"enabled",
"server",
"signer",
"secretName"
],
"title": "The notary Schema",
"type": "object"
},
"persistence": {
"default": {},
"examples": [
{
"enabled": true,
"imageChartStorage": {
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
},
"persistentVolumeClaim": {
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
},
"resourcePolicy": "keep"
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"imageChartStorage": {
"default": {},
"examples": [
{
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
}
],
"properties": {
"azure": {
"default": {},
"examples": [
{
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername"
}
],
"properties": {
"accountkey": {
"default": "base64encodedaccountkey",
"examples": [
"base64encodedaccountkey"
],
"title": "The accountkey Schema",
"type": "string"
},
"accountname": {
"default": "accountname",
"examples": [
"accountname"
],
"title": "The accountname Schema",
"type": "string"
},
"container": {
"default": "containername",
"examples": [
"containername"
],
"title": "The container Schema",
"type": "string"
}
},
"required": [
"accountname",
"accountkey",
"container"
],
"title": "The azure Schema",
"type": "object"
},
"disableredirect": {
"default": false,
"examples": [
false
],
"title": "The disableredirect Schema",
"type": "boolean"
},
"filesystem": {
"default": {},
"examples": [
{
"rootdirectory": "/storage"
}
],
"properties": {
"rootdirectory": {
"default": "/storage",
"examples": [
"/storage"
],
"title": "The rootdirectory Schema",
"type": "string"
}
},
"required": [
"rootdirectory"
],
"title": "The filesystem Schema",
"type": "object"
},
"gcs": {
"default": {},
"examples": [
{
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file"
}
],
"properties": {
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"encodedkey": {
"default": "base64-encoded-json-key-file",
"examples": [
"base64-encoded-json-key-file"
],
"title": "The encodedkey Schema",
"type": "string"
}
},
"required": [
"bucket",
"encodedkey"
],
"title": "The gcs Schema",
"type": "object"
},
"oss": {
"default": {},
"examples": [
{
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
}
],
"properties": {
"accesskeyid": {
"default": "accesskeyid",
"examples": [
"accesskeyid"
],
"title": "The accesskeyid Schema",
"type": "string"
},
"accesskeysecret": {
"default": "accesskeysecret",
"examples": [
"accesskeysecret"
],
"title": "The accesskeysecret Schema",
"type": "string"
},
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"region": {
"default": "regionname",
"examples": [
"regionname"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [
"accesskeyid",
"accesskeysecret",
"region",
"bucket"
],
"title": "The oss Schema",
"type": "object"
},
"s3": {
"default": {},
"examples": [
{
"bucket": "bucketname",
"region": "us-west-1"
}
],
"properties": {
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"region": {
"default": "us-west-1",
"examples": [
"us-west-1"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [
"region",
"bucket"
],
"title": "The s3 Schema",
"type": "object"
},
"swift": {
"default": {},
"examples": [
{
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
}
],
"properties": {
"authurl": {
"default": "https://storage.myprovider.com/v3/auth",
"examples": [
"https://storage.myprovider.com/v3/auth"
],
"title": "The authurl Schema",
"type": "string"
},
"container": {
"default": "containername",
"examples": [
"containername"
],
"title": "The container Schema",
"type": "string"
},
"password": {
"default": "password",
"examples": [
"password"
],
"title": "The password Schema",
"type": "string"
},
"username": {
"default": "username",
"examples": [
"username"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"authurl",
"username",
"password",
"container"
],
"title": "The swift Schema",
"type": "object"
},
"type": {
"default": "filesystem",
"examples": [
"filesystem"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"disableredirect",
"type",
"filesystem",
"azure",
"gcs",
"s3",
"swift",
"oss"
],
"title": "The imageChartStorage Schema",
"type": "object"
},
"persistentVolumeClaim": {
"default": {},
"examples": [
{
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
}
],
"properties": {
"chartmuseum": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The chartmuseum Schema",
"type": "object"
},
"database": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The database Schema",
"type": "object"
},
"jobservice": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The jobservice Schema",
"type": "object"
},
"redis": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The redis Schema",
"type": "object"
},
"registry": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The registry Schema",
"type": "object"
},
"trivy": {
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [
"existingClaim",
"storageClass",
"subPath",
"accessMode",
"size",
"annotations"
],
"title": "The trivy Schema",
"type": "object"
}
},
"required": [
"registry",
"chartmuseum",
"jobservice",
"database",
"redis",
"trivy"
],
"title": "The persistentVolumeClaim Schema",
"type": "object"
},
"resourcePolicy": {
"default": "keep",
"examples": [
"keep"
],
"title": "The resourcePolicy Schema",
"type": "string"
}
},
"required": [
"enabled",
"resourcePolicy",
"persistentVolumeClaim",
"imageChartStorage"
],
"title": "The persistence Schema",
"type": "object"
},
"portal": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:0256993eb356948ba2dfd6e969d2f8da903b849a25a31010a7250931c4d694e5",
"repository": "harbor/harbor-portal"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:0256993eb356948ba2dfd6e969d2f8da903b849a25a31010a7250931c4d694e5",
"repository": "harbor/harbor-portal"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:0256993eb356948ba2dfd6e969d2f8da903b849a25a31010a7250931c4d694e5"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-portal",
"examples": [
"harbor/harbor-portal"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"serviceAccountName",
"automountServiceAccountToken",
"replicas",
"revisionHistoryLimit",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The portal Schema",
"type": "object"
},
"proxy": {
"default": {},
"examples": [
{
"components": [
"core",
"jobservice",
"trivy"
],
"httpProxy": null,
"httpsProxy": null,
"noProxy": "127.0.0.1,localhost,.local,.internal"
}
],
"properties": {
"components": {
"default": [],
"examples": [
[
"core",
"jobservice",
"trivy"
]
],
"items": {
"examples": [
"core",
"jobservice",
"trivy"
],
"title": "A Schema",
"type": "string"
},
"title": "The components Schema",
"type": "array"
},
"httpProxy": {
"default": null,
"examples": [
null
],
"title": "The httpProxy Schema",
"type": "null"
},
"httpsProxy": {
"default": null,
"examples": [
null
],
"title": "The httpsProxy Schema",
"type": "null"
},
"noProxy": {
"default": "127.0.0.1,localhost,.local,.internal",
"examples": [
"127.0.0.1,localhost,.local,.internal"
],
"title": "The noProxy Schema",
"type": "string"
}
},
"required": [
"httpProxy",
"httpsProxy",
"noProxy",
"components"
],
"title": "The proxy Schema",
"type": "object"
},
"redis": {
"default": {},
"examples": [
{
"external": {
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
},
"podAnnotations": {},
"type": "internal"
}
],
"properties": {
"external": {
"default": {},
"examples": [
{
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
}
],
"properties": {
"addr": {
"default": "192.168.0.2:6379",
"examples": [
"192.168.0.2:6379"
],
"title": "The addr Schema",
"type": "string"
},
"chartmuseumDatabaseIndex": {
"default": "3",
"examples": [
"3"
],
"title": "The chartmuseumDatabaseIndex Schema",
"type": "string"
},
"coreDatabaseIndex": {
"default": "0",
"examples": [
"0"
],
"title": "The coreDatabaseIndex Schema",
"type": "string"
},
"jobserviceDatabaseIndex": {
"default": "1",
"examples": [
"1"
],
"title": "The jobserviceDatabaseIndex Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
""
],
"title": "The password Schema",
"type": "string"
},
"registryDatabaseIndex": {
"default": "2",
"examples": [
"2"
],
"title": "The registryDatabaseIndex Schema",
"type": "string"
},
"sentinelMasterSet": {
"default": "",
"examples": [
""
],
"title": "The sentinelMasterSet Schema",
"type": "string"
},
"trivyAdapterIndex": {
"default": "5",
"examples": [
"5"
],
"title": "The trivyAdapterIndex Schema",
"type": "string"
}
},
"required": [
"addr",
"sentinelMasterSet",
"coreDatabaseIndex",
"jobserviceDatabaseIndex",
"registryDatabaseIndex",
"chartmuseumDatabaseIndex",
"trivyAdapterIndex",
"password"
],
"title": "The external Schema",
"type": "object"
},
"internal": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab",
"repository": "harbor/harbor-redis"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:c6965121d1b79a79d5ee2d4559f0e824efa2ac4f9e4801afb2bb17db914317ab"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-redis",
"examples": [
"harbor/harbor-redis"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"image",
"nodeSelector",
"tolerations",
"affinity",
"priorityClassName"
],
"title": "The internal Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"type": {
"default": "internal",
"examples": [
"internal"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"internal",
"external",
"podAnnotations"
],
"title": "The redis Schema",
"type": "object"
},
"registry": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"controller": {
"image": {
"digest": "sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761",
"repository": "harbor/harbor-registryctl"
}
},
"credentials": {
"password": "harbor_registry_password",
"username": "harbor_registry_user"
},
"middleware": {
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"registry": {
"image": {
"digest": "sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3",
"repository": "harbor/harbor-registry"
}
},
"relativeurls": false,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": [],
"upload_purging": {
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"controller": {
"default": {},
"examples": [
{
"image": {
"digest": "sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761",
"repository": "harbor/harbor-registryctl"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"digest": "sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761",
"repository": "harbor/harbor-registryctl"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:87a843a80ce5c247c81e1e90b9994fba3c20ba9375ea9e29cf160ecd12524761"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-registryctl",
"examples": [
"harbor/harbor-registryctl"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The controller Schema",
"type": "object"
},
"credentials": {
"default": {},
"examples": [
{
"password": "harbor_registry_password",
"username": "harbor_registry_user"
}
],
"properties": {
"password": {
"default": "harbor_registry_password",
"examples": [
"harbor_registry_password"
],
"title": "The password Schema",
"type": "string"
},
"username": {
"default": "harbor_registry_user",
"examples": [
"harbor_registry_user"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"username",
"password"
],
"title": "The credentials Schema",
"type": "object"
},
"middleware": {
"default": {},
"examples": [
{
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
}
],
"properties": {
"cloudFront": {
"default": {},
"examples": [
{
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
}
],
"properties": {
"baseurl": {
"default": "example.cloudfront.net",
"examples": [
"example.cloudfront.net"
],
"title": "The baseurl Schema",
"type": "string"
},
"duration": {
"default": "3000s",
"examples": [
"3000s"
],
"title": "The duration Schema",
"type": "string"
},
"ipfilteredby": {
"default": "none",
"examples": [
"none"
],
"title": "The ipfilteredby Schema",
"type": "string"
},
"keypairid": {
"default": "KEYPAIRID",
"examples": [
"KEYPAIRID"
],
"title": "The keypairid Schema",
"type": "string"
},
"privateKeySecret": {
"default": "my-secret",
"examples": [
"my-secret"
],
"title": "The privateKeySecret Schema",
"type": "string"
}
},
"required": [
"baseurl",
"keypairid",
"duration",
"ipfilteredby",
"privateKeySecret"
],
"title": "The cloudFront Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"type": {
"default": "cloudFront",
"examples": [
"cloudFront"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"enabled",
"type",
"cloudFront"
],
"title": "The middleware Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"registry": {
"default": {},
"examples": [
{
"image": {
"digest": "sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3",
"repository": "harbor/harbor-registry"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"digest": "sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3",
"repository": "harbor/harbor-registry"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:d2e0dc83df17e6b5d13d7adcbfbe1cffe6dba82c39a7562ecf21e876f1271bd3"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-registry",
"examples": [
"harbor/harbor-registry"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The registry Schema",
"type": "object"
},
"relativeurls": {
"default": false,
"examples": [
false
],
"title": "The relativeurls Schema",
"type": "boolean"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"upload_purging": {
"default": {},
"examples": [
{
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
],
"properties": {
"age": {
"default": "168h",
"examples": [
"168h"
],
"title": "The age Schema",
"type": "string"
},
"dryrun": {
"default": false,
"examples": [
false
],
"title": "The dryrun Schema",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "24h",
"examples": [
"24h"
],
"title": "The interval Schema",
"type": "string"
}
},
"required": [
"enabled",
"age",
"interval",
"dryrun"
],
"title": "The upload_purging Schema",
"type": "object"
}
},
"required": [
"serviceAccountName",
"automountServiceAccountToken",
"registry",
"controller",
"replicas",
"revisionHistoryLimit",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName",
"secret",
"relativeurls",
"credentials",
"middleware",
"upload_purging"
],
"title": "The registry Schema",
"type": "object"
},
"secretKey": {
"default": "",
"examples": [
""
],
"title": "The secretKey Schema",
"type": "string"
},
"sourceRegistry": {
"default": "public.ecr.aws/eks-anywhere",
"examples": [
"public.ecr.aws/eks-anywhere"
],
"title": "The sourceRegistry Schema",
"type": "string"
},
"trace": {
"default": {},
"examples": [
{
"enabled": false,
"jaeger": {
"endpoint": "http://hostname:14268/api/traces"
},
"otel": {
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
},
"provider": "jaeger",
"sample_rate": 1
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"jaeger": {
"default": {},
"examples": [
{
"endpoint": "http://hostname:14268/api/traces"
}
],
"properties": {
"endpoint": {
"default": "http://hostname:14268/api/traces",
"examples": [
"http://hostname:14268/api/traces"
],
"title": "The endpoint Schema",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "The jaeger Schema",
"type": "object"
},
"otel": {
"default": {},
"examples": [
{
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": "10s",
"url_path": "/v1/traces"
}
],
"properties": {
"compression": {
"default": false,
"examples": [
false
],
"title": "The compression Schema",
"type": "boolean"
},
"endpoint": {
"default": "hostname:4318",
"examples": [
"hostname:4318"
],
"title": "The endpoint Schema",
"type": "string"
},
"insecure": {
"default": true,
"examples": [
true
],
"title": "The insecure Schema",
"type": "boolean"
},
"timeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The timeout Schema",
"type": "string"
},
"url_path": {
"default": "/v1/traces",
"examples": [
"/v1/traces"
],
"title": "The url_path Schema",
"type": "string"
}
},
"required": [
"endpoint",
"url_path",
"compression",
"insecure",
"timeout"
],
"title": "The otel Schema",
"type": "object"
},
"provider": {
"default": "jaeger",
"examples": [
"jaeger"
],
"title": "The provider Schema",
"type": "string"
},
"sample_rate": {
"default": 1,
"examples": [
1
],
"title": "The sample_rate Schema",
"type": "integer"
}
},
"required": [
"enabled",
"provider",
"sample_rate",
"jaeger",
"otel"
],
"title": "The trace Schema",
"type": "object"
},
"trivy": {
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"debugMode": false,
"enabled": true,
"gitHubToken": "",
"ignoreUnfixed": false,
"image": {
"digest": "sha256:829fc3d40ba7423280ed8d7a51ea6345283fa35c21177998902f5b311f5be0be",
"repository": "harbor/harbor-trivy"
},
"insecure": false,
"nodeSelector": {},
"offlineScan": false,
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"resources": {
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
},
"serviceAccountName": "",
"severity": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"skipUpdate": false,
"timeout": "5m0s",
"tolerations": [],
"vulnType": "os,library"
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"debugMode": {
"default": false,
"examples": [
false
],
"title": "The debugMode Schema",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"gitHubToken": {
"default": "",
"examples": [
""
],
"title": "The gitHubToken Schema",
"type": "string"
},
"ignoreUnfixed": {
"default": false,
"examples": [
false
],
"title": "The ignoreUnfixed Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:829fc3d40ba7423280ed8d7a51ea6345283fa35c21177998902f5b311f5be0be",
"repository": "harbor/harbor-trivy"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:829fc3d40ba7423280ed8d7a51ea6345283fa35c21177998902f5b311f5be0be"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-trivy",
"examples": [
"harbor/harbor-trivy"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"insecure": {
"default": false,
"examples": [
false
],
"title": "The insecure Schema",
"type": "boolean"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"offlineScan": {
"default": false,
"examples": [
false
],
"title": "The offlineScan Schema",
"type": "boolean"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": 1,
"memory": "1Gi"
}
],
"properties": {
"cpu": {
"default": 1,
"examples": [
1
],
"title": "The cpu Schema",
"type": "integer"
},
"memory": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "200m",
"memory": "512Mi"
}
],
"properties": {
"cpu": {
"default": "200m",
"examples": [
"200m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "512Mi",
"examples": [
"512Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "The resources Schema",
"type": "object"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"severity": {
"default": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"examples": [
"UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL"
],
"title": "The severity Schema",
"type": "string"
},
"skipUpdate": {
"default": false,
"examples": [
false
],
"title": "The skipUpdate Schema",
"type": "boolean"
},
"timeout": {
"default": "5m0s",
"examples": [
"5m0s"
],
"title": "The timeout Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"vulnType": {
"default": "os,library",
"examples": [
"os,library"
],
"title": "The vulnType Schema",
"type": "string"
}
},
"required": [
"enabled",
"image",
"serviceAccountName",
"automountServiceAccountToken",
"replicas",
"debugMode",
"vulnType",
"severity",
"ignoreUnfixed",
"insecure",
"gitHubToken",
"skipUpdate",
"offlineScan",
"timeout",
"resources",
"nodeSelector",
"tolerations",
"affinity",
"podAnnotations",
"priorityClassName"
],
"title": "The trivy Schema",
"type": "object"
},
"updateStrategy": {
"default": {},
"examples": [
{
"type": "Recreate"
}
],
"properties": {
"type": {
"default": "Recreate",
"examples": [
"Recreate"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type"
],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"required": [
"sourceRegistry",
"expose",
"externalURL",
"internalTLS",
"ipFamily",
"persistence",
"imagePullPolicy",
"imagePullSecrets",
"updateStrategy",
"logLevel",
"harborAdminPassword",
"caSecretName",
"secretKey",
"proxy",
"enableMigrateHelmHook",
"nginx",
"portal",
"core",
"jobservice",
"registry",
"chartmuseum",
"trivy",
"notary",
"database",
"redis",
"exporter",
"metrics",
"trace"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | f99141f59b89eb69dbea11ddc0cc5cfac270fc41 | 2023-01-05T13:18:28 | projects/kubernetes-sigs/metrics-server/1-25/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 4443,
"examples": [
4443
],
"title": "The containerPort Schema",
"type": "integer"
},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | e53b05219ea2000162b1c3efa5bed53be91c633a | 2023-08-25T00:09:25 | projects/kubernetes-sigs/metrics-server/1-28/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 4443,
"examples": [
4443
],
"title": "The containerPort Schema",
"type": "integer"
},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 91ce512a7627aaa47e1314183e0dc6ef3073db66 | 2023-11-30T23:34:47 | projects/kubernetes/autoscaler/1-29/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"additionalLabels": {},
"affinity": {},
"autoDiscovery": {
"clusterName": "my-cluster",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
},
"autoscalingGroups": [],
"autoscalingGroupsnamePrefix": [],
"awsAccessKeyID": "",
"awsRegion": "us-east-1",
"awsSecretAccessKey": "",
"azureClientID": "",
"azureClientSecret": "",
"azureClusterName": "",
"azureNodeResourceGroup": "",
"azureResourceGroup": "",
"azureSubscriptionID": "",
"azureTenantID": "",
"azureUseManagedIdentityExtension": false,
"azureVMType": "AKS",
"cloudConfigPath": "",
"cloudProvider": "clusterapi",
"clusterAPICloudConfigPath": "/etc/kubernetes/mgmt-kubeconfig",
"clusterAPIConfigMapsNamespace": "",
"clusterAPIKubeconfigSecret": "",
"clusterAPIMode": "incluster-incluster",
"clusterAPIWorkloadKubeconfigPath": "/etc/kubernetes/value",
"containerSecurityContext": {},
"deployment": {
"annotations": {}
},
"dnsPolicy": "ClusterFirst",
"envFromConfigMap": "",
"envFromSecret": "",
"expanderPriorities": {},
"extraArgs": {
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
},
"extraEnv": {},
"extraEnvConfigMaps": {},
"extraEnvSecrets": {},
"extraVolumeMounts": [],
"extraVolumeSecrets": {},
"extraVolumes": [],
"fullnameOverride": "",
"image": {
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
},
"imagePullSecrets": [],
"kubeTargetVersionOverride": "",
"magnumCABundlePath": "/etc/kubernetes/ca-bundle.crt",
"magnumClusterName": "",
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"maxUnavailable": 1
},
"podLabels": {},
"priorityClassName": "system-cluster-critical",
"priorityConfigMapAnnotations": {},
"prometheusRule": {
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
},
"rbac": {
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
},
"replicaCount": 1,
"resources": {},
"securityContext": {},
"service": {
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
},
"sourceRegistry": "public.ecr.aws",
"tolerations": [],
"topologySpreadConstraints": [],
"updateStrategy": {}
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"autoDiscovery": {
"default": {},
"examples": [
{
"clusterName": "my-cluster-name",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
}
],
"properties": {
"clusterName": {
"default": "",
"examples": [
"my-cluster-name"
],
"title": "The clusterName Schema",
"type": "string"
},
"labels": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The labels Schema",
"type": "array"
},
"roles": {
"default": [],
"examples": [
[
"worker"
]
],
"items": {
"default": "",
"examples": [
"worker"
],
"title": "A Schema",
"type": "string"
},
"title": "The roles Schema",
"type": "array"
},
"tags": {
"default": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"examples": [
[
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
],
"items": {
"examples": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"title": "A Schema",
"type": "string"
},
"title": "The tags Schema",
"type": "array"
}
},
"required": [],
"title": "The autoDiscovery Schema",
"type": "object"
},
"autoscalingGroups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroups Schema",
"type": "array"
},
"autoscalingGroupsnamePrefix": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroupsnamePrefix Schema",
"type": "array"
},
"awsAccessKeyID": {
"default": "",
"examples": [
""
],
"title": "The awsAccessKeyID Schema",
"type": "string"
},
"awsRegion": {
"default": "",
"examples": [
"us-east-1"
],
"title": "The awsRegion Schema",
"type": "string"
},
"awsSecretAccessKey": {
"default": "",
"examples": [
""
],
"title": "The awsSecretAccessKey Schema",
"type": "string"
},
"azureClientID": {
"default": "",
"examples": [
""
],
"title": "The azureClientID Schema",
"type": "string"
},
"azureClientSecret": {
"default": "",
"examples": [
""
],
"title": "The azureClientSecret Schema",
"type": "string"
},
"azureClusterName": {
"default": "",
"examples": [
""
],
"title": "The azureClusterName Schema",
"type": "string"
},
"azureNodeResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureNodeResourceGroup Schema",
"type": "string"
},
"azureResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureResourceGroup Schema",
"type": "string"
},
"azureSubscriptionID": {
"default": "",
"examples": [
""
],
"title": "The azureSubscriptionID Schema",
"type": "string"
},
"azureTenantID": {
"default": "",
"examples": [
""
],
"title": "The azureTenantID Schema",
"type": "string"
},
"azureUseManagedIdentityExtension": {
"default": false,
"examples": [
false
],
"title": "The azureUseManagedIdentityExtension Schema",
"type": "boolean"
},
"azureVMType": {
"default": "",
"examples": [
"AKS"
],
"title": "The azureVMType Schema",
"type": "string"
},
"cloudConfigPath": {
"default": "",
"examples": [
""
],
"title": "The cloudConfigPath Schema",
"type": "string"
},
"cloudProvider": {
"default": "",
"examples": [
"clusterapi"
],
"title": "The cloudProvider Schema",
"type": "string"
},
"clusterAPICloudConfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/mgmt-kubeconfig"
],
"title": "The clusterAPICloudConfigPath Schema",
"type": "string"
},
"clusterAPIConfigMapsNamespace": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIConfigMapsNamespace Schema",
"type": "string"
},
"clusterAPIKubeconfigSecret": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIKubeconfigSecret Schema",
"type": "string"
},
"clusterAPIMode": {
"default": "",
"examples": [
"incluster-incluster"
],
"title": "The clusterAPIMode Schema",
"type": "string"
},
"clusterAPIWorkloadKubeconfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/value"
],
"title": "The clusterAPIWorkloadKubeconfigPath Schema",
"type": "string"
},
"containerSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The containerSecurityContext Schema",
"type": "object"
},
"deployment": {
"default": {},
"examples": [
{
"annotations": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
}
},
"required": [
"annotations"
],
"title": "The deployment Schema",
"type": "object"
},
"dnsPolicy": {
"default": "",
"examples": [
"ClusterFirst"
],
"title": "The dnsPolicy Schema",
"type": "string"
},
"envFromConfigMap": {
"default": "",
"examples": [
""
],
"title": "The envFromConfigMap Schema",
"type": "string"
},
"envFromSecret": {
"default": "",
"examples": [
""
],
"title": "The envFromSecret Schema",
"type": "string"
},
"expanderPriorities": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The expanderPriorities Schema",
"type": "object"
},
"extraArgs": {
"default": {},
"examples": [
{
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
}
],
"properties": {
"logtostderr": {
"default": true,
"examples": [
true
],
"title": "The logtostderr Schema",
"type": "boolean"
},
"stderrthreshold": {
"default": "info",
"examples": [
"info"
],
"title": "The stderrthreshold Schema",
"type": "string"
},
"v": {
"default": 4,
"examples": [
4
],
"title": "The v Schema",
"type": "integer"
}
},
"required": [],
"title": "The extraArgs Schema",
"type": "object"
},
"extraEnv": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnv Schema",
"type": "object"
},
"extraEnvConfigMaps": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvConfigMaps Schema",
"type": "object"
},
"extraEnvSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvSecrets Schema",
"type": "object"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumeSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraVolumeSecrets Schema",
"type": "object"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "kubernetes/autoscaler",
"examples": [
"kubernetes/autoscaler"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeTargetVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeTargetVersionOverride Schema",
"type": "string"
},
"magnumCABundlePath": {
"default": "",
"examples": [
"/etc/kubernetes/ca-bundle.crt"
],
"title": "The magnumCABundlePath Schema",
"type": "string"
},
"magnumClusterName": {
"default": "",
"examples": [
""
],
"title": "The magnumClusterName Schema",
"type": "string"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"maxUnavailable": 1
}
],
"properties": {
"maxUnavailable": {
"default": 1,
"examples": [
1
],
"title": "The maxUnavailable Schema",
"type": "integer"
}
},
"required": [
"maxUnavailable"
],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"priorityConfigMapAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The priorityConfigMapAnnotations Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"rules": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The rules Schema",
"type": "array"
}
},
"required": [],
"title": "The prometheusRule Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
}
],
"properties": {
"clusterScoped": {
"default": true,
"examples": [
true
],
"title": "The clusterScoped Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"externalIPs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The externalIPs Schema",
"type": "array"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"loadBalancerIP": {
"default": "",
"examples": [
""
],
"title": "The loadBalancerIP Schema",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The loadBalancerSourceRanges Schema",
"type": "array"
},
"portName": {
"default": "http",
"examples": [
"http"
],
"title": "The portName Schema",
"type": "string"
},
"servicePort": {
"default": 8085,
"examples": [
8085
],
"title": "The servicePort Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The metricRelabelings Schema",
"type": "object"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"selector": {
"default": {},
"examples": [
{
"release": "prometheus-operator"
}
],
"properties": {
"release": {
"default": "prometheus-operator",
"examples": [
"prometheus-operator"
],
"title": "The release Schema",
"type": "string"
}
},
"required": [],
"title": "The selector Schema",
"type": "object"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 6edfaf6428dc197486cb0bd8e0371df1d67d6009 | 2023-04-28T18:48:29 | projects/kubernetes-sigs/metrics-server/1-27/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 4443,
"examples": [
4443
],
"title": "The containerPort Schema",
"type": "integer"
},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | e94935b5816c73f3ad2ffd15113a75853f45adf6 | 2022-10-05T23:38:42 | projects/cert-manager/cert-manager/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"examples": [
{
"affinity": {},
"cainjector": {
"affinity": {},
"containerSecurityContext": {
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
},
"enabled": true,
"extraArgs": [],
"image": {
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-cainjector"
},
"nodeSelector": {
"kubernetes.io/os": "linux"
},
"podLabels": {},
"replicaCount": 1,
"resources": {},
"securityContext": {
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
},
"serviceAccount": {
"automountServiceAccountToken": true,
"create": true
},
"strategy": {},
"tolerations": [],
"topologySpreadConstraints": []
},
"clusterResourceNamespace": "",
"containerSecurityContext": {
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
},
"extraArgs": [],
"extraEnv": [],
"featureGates": "",
"global": {
"commonLabels": {},
"imagePullSecrets": [],
"leaderElection": {
"namespace": "kube-system"
},
"logLevel": 2,
"podSecurityPolicy": {
"enabled": false,
"useAppArmor": true
},
"priorityClassName": "",
"rbac": {
"aggregateClusterRoles": true,
"create": true
}
},
"image": {
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-controller"
},
"ingressShim": {},
"installCRDs": false,
"namespace": "",
"nodeSelector": {
"kubernetes.io/os": "linux"
},
"podLabels": {},
"prometheus": {
"enabled": true,
"servicemonitor": {
"annotations": {},
"enabled": false,
"honorLabels": false,
"interval": "60s",
"labels": {},
"path": "/metrics",
"prometheusInstance": "default",
"scrapeTimeout": "30s",
"targetPort": 9402
}
},
"replicaCount": 1,
"resources": {},
"securityContext": {
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
},
"serviceAccount": {
"automountServiceAccountToken": true,
"create": true
},
"startupapicheck": {
"affinity": {},
"backoffLimit": 4,
"containerSecurityContext": {
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
},
"enabled": true,
"extraArgs": [],
"image": {
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-ctl"
},
"jobAnnotations": {
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "1"
},
"nodeSelector": {
"kubernetes.io/os": "linux"
},
"podLabels": {},
"rbac": {
"annotations": {
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "-5"
}
},
"resources": {},
"securityContext": {
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
},
"serviceAccount": {
"annotations": {
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "-5"
},
"automountServiceAccountToken": true,
"create": true
},
"timeout": "1m",
"tolerations": []
},
"strategy": {},
"tolerations": [],
"topologySpreadConstraints": [],
"volumeMounts": [],
"volumes": [],
"webhook": {
"affinity": {},
"config": null,
"containerSecurityContext": {
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
},
"extraArgs": [],
"hostNetwork": false,
"image": {
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-webhook"
},
"livenessProbe": {
"failureThreshold": 3,
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 1
},
"networkPolicy": {
"egress": [
{
"ports": [
{
"port": 80,
"protocol": "TCP"
},
{
"port": 443,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "UDP"
}
],
"to": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
],
"enabled": false,
"ingress": [
{
"from": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
]
},
"nodeSelector": {
"kubernetes.io/os": "linux"
},
"podLabels": {},
"readinessProbe": {
"failureThreshold": 3,
"initialDelaySeconds": 5,
"periodSeconds": 5,
"successThreshold": 1,
"timeoutSeconds": 1
},
"replicaCount": 1,
"resources": {},
"securePort": 10250,
"securityContext": {
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
},
"serviceAccount": {
"automountServiceAccountToken": true,
"create": true
},
"serviceLabels": {},
"serviceType": "ClusterIP",
"strategy": {},
"timeoutSeconds": 10,
"tolerations": [],
"topologySpreadConstraints": [],
"url": {}
}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The affinity Schema",
"type": "object"
},
"cainjector": {
"default": {},
"examples": [
{
"affinity": {},
"containerSecurityContext": {
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
},
"enabled": true,
"extraArgs": [],
"image": {
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-cainjector"
},
"nodeSelector": {
"kubernetes.io/os": "linux"
},
"podLabels": {},
"replicaCount": 1,
"resources": {},
"securityContext": {
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
},
"serviceAccount": {
"automountServiceAccountToken": true,
"create": true
},
"strategy": {},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The affinity Schema",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"capabilities": {
"default": {},
"examples": [
{
"drop": [
"ALL"
]
}
],
"properties": {
"drop": {
"default": [],
"examples": [
[
"ALL"
]
],
"items": {
"default": "",
"examples": [
"ALL"
],
"title": "A Schema",
"type": "string"
},
"title": "The drop Schema",
"type": "array"
}
},
"title": "The capabilities Schema",
"type": "object"
}
},
"title": "The containerSecurityContext Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-cainjector"
}
],
"properties": {
"pullPolicy": {
"default": "",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "",
"examples": [
"quay.io/jetstack/cert-manager-cainjector"
],
"title": "The repository Schema",
"type": "string"
}
},
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{
"kubernetes.io/os": "linux"
}
],
"properties": {
"kubernetes.io/os": {
"default": "",
"examples": [
"linux"
],
"title": "The kubernetes.io/os Schema",
"type": "string"
}
},
"title": "The nodeSelector Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The podLabels Schema",
"type": "object"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
}
],
"properties": {
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"seccompProfile": {
"default": {},
"examples": [
{
"type": "RuntimeDefault"
}
],
"properties": {
"type": {
"default": "",
"examples": [
"RuntimeDefault"
],
"title": "The type Schema",
"type": "string"
}
},
"title": "The seccompProfile Schema",
"type": "object"
}
},
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"automountServiceAccountToken": true,
"create": true
}
],
"properties": {
"automountServiceAccountToken": {
"default": false,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"title": "The serviceAccount Schema",
"type": "object"
},
"strategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The strategy Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"title": "The cainjector Schema",
"type": "object"
},
"clusterResourceNamespace": {
"default": "",
"examples": [
""
],
"title": "The clusterResourceNamespace Schema",
"type": "string"
},
"containerSecurityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"capabilities": {
"default": {},
"examples": [
{
"drop": [
"ALL"
]
}
],
"properties": {
"drop": {
"default": [],
"examples": [
[
"ALL"
]
],
"items": {
"default": "",
"examples": [
"ALL"
],
"title": "A Schema",
"type": "string"
},
"title": "The drop Schema",
"type": "array"
}
},
"title": "The capabilities Schema",
"type": "object"
}
},
"title": "The containerSecurityContext Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"extraEnv": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraEnv Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"global": {
"default": {},
"examples": [
{
"commonLabels": {},
"imagePullSecrets": [],
"leaderElection": {
"namespace": "kube-system"
},
"logLevel": 2,
"podSecurityPolicy": {
"enabled": false,
"useAppArmor": true
},
"priorityClassName": "",
"rbac": {
"aggregateClusterRoles": true,
"create": true
}
}
],
"properties": {
"commonLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The commonLabels Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"leaderElection": {
"default": {},
"examples": [
{
"namespace": "kube-system"
}
],
"properties": {
"namespace": {
"default": "",
"examples": [
"kube-system"
],
"title": "The namespace Schema",
"type": "string"
}
},
"title": "The leaderElection Schema",
"type": "object"
},
"logLevel": {
"default": 0,
"examples": [
2
],
"title": "The logLevel Schema",
"type": "integer"
},
"podSecurityPolicy": {
"default": {},
"examples": [
{
"enabled": false,
"useAppArmor": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"useAppArmor": {
"default": false,
"examples": [
true
],
"title": "The useAppArmor Schema",
"type": "boolean"
}
},
"title": "The podSecurityPolicy Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"rbac": {
"default": {},
"examples": [
{
"aggregateClusterRoles": true,
"create": true
}
],
"properties": {
"aggregateClusterRoles": {
"default": false,
"examples": [
true
],
"title": "The aggregateClusterRoles Schema",
"type": "boolean"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"title": "The rbac Schema",
"type": "object"
}
},
"title": "The global Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-controller"
}
],
"properties": {
"pullPolicy": {
"default": "",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "",
"examples": [
"quay.io/jetstack/cert-manager-controller"
],
"title": "The repository Schema",
"type": "string"
}
},
"title": "The image Schema",
"type": "object"
},
"ingressShim": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The ingressShim Schema",
"type": "object"
},
"installCRDs": {
"default": false,
"examples": [
false
],
"title": "The installCRDs Schema",
"type": "boolean"
},
"namespace": {
"default": "",
"examples": [
""
],
"title": "The namespace Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{
"kubernetes.io/os": "linux"
}
],
"properties": {
"kubernetes.io/os": {
"default": "",
"examples": [
"linux"
],
"title": "The kubernetes.io/os Schema",
"type": "string"
}
},
"title": "The nodeSelector Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The podLabels Schema",
"type": "object"
},
"prometheus": {
"default": {},
"examples": [
{
"enabled": true,
"servicemonitor": {
"annotations": {},
"enabled": false,
"honorLabels": false,
"interval": "60s",
"labels": {},
"path": "/metrics",
"prometheusInstance": "default",
"scrapeTimeout": "30s",
"targetPort": 9402
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"servicemonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"honorLabels": false,
"interval": "60s",
"labels": {},
"path": "/metrics",
"prometheusInstance": "default",
"scrapeTimeout": "30s",
"targetPort": 9402
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"honorLabels": {
"default": false,
"examples": [
false
],
"title": "The honorLabels Schema",
"type": "boolean"
},
"interval": {
"default": "",
"examples": [
"60s"
],
"title": "The interval Schema",
"type": "string"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The labels Schema",
"type": "object"
},
"path": {
"default": "",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"prometheusInstance": {
"default": "",
"examples": [
"default"
],
"title": "The prometheusInstance Schema",
"type": "string"
},
"scrapeTimeout": {
"default": "",
"examples": [
"30s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
},
"targetPort": {
"default": 0,
"examples": [
9402
],
"title": "The targetPort Schema",
"type": "integer"
}
},
"title": "The servicemonitor Schema",
"type": "object"
}
},
"title": "The prometheus Schema",
"type": "object"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
}
],
"properties": {
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"seccompProfile": {
"default": {},
"examples": [
{
"type": "RuntimeDefault"
}
],
"properties": {
"type": {
"default": "",
"examples": [
"RuntimeDefault"
],
"title": "The type Schema",
"type": "string"
}
},
"title": "The seccompProfile Schema",
"type": "object"
}
},
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"automountServiceAccountToken": true,
"create": true
}
],
"properties": {
"automountServiceAccountToken": {
"default": false,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"title": "The serviceAccount Schema",
"type": "object"
},
"startupapicheck": {
"default": {},
"examples": [
{
"affinity": {},
"backoffLimit": 4,
"containerSecurityContext": {
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
},
"enabled": true,
"extraArgs": [],
"image": {
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-ctl"
},
"jobAnnotations": {
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "1"
},
"nodeSelector": {
"kubernetes.io/os": "linux"
},
"podLabels": {},
"rbac": {
"annotations": {
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "-5"
}
},
"resources": {},
"securityContext": {
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
},
"serviceAccount": {
"annotations": {
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "-5"
},
"automountServiceAccountToken": true,
"create": true
},
"timeout": "1m",
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The affinity Schema",
"type": "object"
},
"backoffLimit": {
"default": 0,
"examples": [
4
],
"title": "The backoffLimit Schema",
"type": "integer"
},
"containerSecurityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"capabilities": {
"default": {},
"examples": [
{
"drop": [
"ALL"
]
}
],
"properties": {
"drop": {
"default": [],
"examples": [
[
"ALL"
]
],
"items": {
"default": "",
"examples": [
"ALL"
],
"title": "A Schema",
"type": "string"
},
"title": "The drop Schema",
"type": "array"
}
},
"title": "The capabilities Schema",
"type": "object"
}
},
"title": "The containerSecurityContext Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-ctl"
}
],
"properties": {
"pullPolicy": {
"default": "",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "",
"examples": [
"quay.io/jetstack/cert-manager-ctl"
],
"title": "The repository Schema",
"type": "string"
}
},
"title": "The image Schema",
"type": "object"
},
"jobAnnotations": {
"default": {},
"examples": [
{
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "1"
}
],
"properties": {
"helm.sh/hook": {
"default": "",
"examples": [
"post-install"
],
"title": "The helm.sh/hook Schema",
"type": "string"
},
"helm.sh/hook-delete-policy": {
"default": "",
"examples": [
"before-hook-creation,hook-succeeded"
],
"title": "The helm.sh/hook-delete-policy Schema",
"type": "string"
},
"helm.sh/hook-weight": {
"default": "",
"examples": [
"1"
],
"title": "The helm.sh/hook-weight Schema",
"type": "string"
}
},
"title": "The jobAnnotations Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{
"kubernetes.io/os": "linux"
}
],
"properties": {
"kubernetes.io/os": {
"default": "",
"examples": [
"linux"
],
"title": "The kubernetes.io/os Schema",
"type": "string"
}
},
"title": "The nodeSelector Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The podLabels Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"annotations": {
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "-5"
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "-5"
}
],
"properties": {
"helm.sh/hook": {
"default": "",
"examples": [
"post-install"
],
"title": "The helm.sh/hook Schema",
"type": "string"
},
"helm.sh/hook-delete-policy": {
"default": "",
"examples": [
"before-hook-creation,hook-succeeded"
],
"title": "The helm.sh/hook-delete-policy Schema",
"type": "string"
},
"helm.sh/hook-weight": {
"default": "",
"examples": [
"-5"
],
"title": "The helm.sh/hook-weight Schema",
"type": "string"
}
},
"title": "The annotations Schema",
"type": "object"
}
},
"title": "The rbac Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
}
],
"properties": {
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"seccompProfile": {
"default": {},
"examples": [
{
"type": "RuntimeDefault"
}
],
"properties": {
"type": {
"default": "",
"examples": [
"RuntimeDefault"
],
"title": "The type Schema",
"type": "string"
}
},
"title": "The seccompProfile Schema",
"type": "object"
}
},
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "-5"
},
"automountServiceAccountToken": true,
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"helm.sh/hook": "post-install",
"helm.sh/hook-delete-policy": "before-hook-creation,hook-succeeded",
"helm.sh/hook-weight": "-5"
}
],
"properties": {
"helm.sh/hook": {
"default": "",
"examples": [
"post-install"
],
"title": "The helm.sh/hook Schema",
"type": "string"
},
"helm.sh/hook-delete-policy": {
"default": "",
"examples": [
"before-hook-creation,hook-succeeded"
],
"title": "The helm.sh/hook-delete-policy Schema",
"type": "string"
},
"helm.sh/hook-weight": {
"default": "",
"examples": [
"-5"
],
"title": "The helm.sh/hook-weight Schema",
"type": "string"
}
},
"title": "The annotations Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"title": "The serviceAccount Schema",
"type": "object"
},
"timeout": {
"default": "",
"examples": [
"1m"
],
"title": "The timeout Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"title": "The startupapicheck Schema",
"type": "object"
},
"strategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The strategy Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"volumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The volumeMounts Schema",
"type": "array"
},
"volumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The volumes Schema",
"type": "array"
},
"webhook": {
"default": {},
"examples": [
{
"affinity": {},
"config": null,
"containerSecurityContext": {
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
},
"extraArgs": [],
"hostNetwork": false,
"image": {
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-webhook"
},
"livenessProbe": {
"failureThreshold": 3,
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 1
},
"networkPolicy": {
"egress": [
{
"ports": [
{
"port": 80,
"protocol": "TCP"
},
{
"port": 443,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "UDP"
}
],
"to": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
],
"enabled": false,
"ingress": [
{
"from": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
]
},
"nodeSelector": {
"kubernetes.io/os": "linux"
},
"podLabels": {},
"readinessProbe": {
"failureThreshold": 3,
"initialDelaySeconds": 5,
"periodSeconds": 5,
"successThreshold": 1,
"timeoutSeconds": 1
},
"replicaCount": 1,
"resources": {},
"securePort": 10250,
"securityContext": {
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
},
"serviceAccount": {
"automountServiceAccountToken": true,
"create": true
},
"serviceLabels": {},
"serviceType": "ClusterIP",
"strategy": {},
"timeoutSeconds": 10,
"tolerations": [],
"topologySpreadConstraints": [],
"url": {}
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The affinity Schema",
"type": "object"
},
"config": {
"default": null,
"examples": [
null
],
"title": "The config Schema",
"type": "null"
},
"containerSecurityContext": {
"default": {},
"examples": [
{
"allowPrivilegeEscalation": false,
"capabilities": {
"drop": [
"ALL"
]
}
}
],
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"capabilities": {
"default": {},
"examples": [
{
"drop": [
"ALL"
]
}
],
"properties": {
"drop": {
"default": [],
"examples": [
[
"ALL"
]
],
"items": {
"default": "",
"examples": [
"ALL"
],
"title": "A Schema",
"type": "string"
},
"title": "The drop Schema",
"type": "array"
}
},
"title": "The capabilities Schema",
"type": "object"
}
},
"title": "The containerSecurityContext Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "quay.io/jetstack/cert-manager-webhook"
}
],
"properties": {
"pullPolicy": {
"default": "",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "",
"examples": [
"quay.io/jetstack/cert-manager-webhook"
],
"title": "The repository Schema",
"type": "string"
}
},
"title": "The image Schema",
"type": "object"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 1
}
],
"properties": {
"failureThreshold": {
"default": 0,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
60
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 0,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
},
"successThreshold": {
"default": 0,
"examples": [
1
],
"title": "The successThreshold Schema",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
1
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"title": "The livenessProbe Schema",
"type": "object"
},
"networkPolicy": {
"default": {},
"examples": [
{
"egress": [
{
"ports": [
{
"port": 80,
"protocol": "TCP"
},
{
"port": 443,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "UDP"
}
],
"to": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
],
"enabled": false,
"ingress": [
{
"from": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
]
}
],
"properties": {
"egress": {
"default": [],
"examples": [
[
{
"ports": [
{
"port": 80,
"protocol": "TCP"
},
{
"port": 443,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "UDP"
}
],
"to": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
]
],
"items": {
"default": {},
"examples": [
{
"ports": [
{
"port": 80,
"protocol": "TCP"
},
{
"port": 443,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "UDP"
}
],
"to": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
],
"properties": {
"ports": {
"default": [],
"examples": [
[
{
"port": 80,
"protocol": "TCP"
},
{
"port": 443,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "UDP"
}
]
],
"items": {
"examples": [
{
"port": 80,
"protocol": "TCP"
},
{
"port": 443,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "TCP"
},
{
"port": 53,
"protocol": "UDP"
}
],
"properties": {
"port": {
"examples": [
80,
443,
53
],
"title": "The port Schema",
"type": "integer"
},
"protocol": {
"examples": [
"TCP",
"UDP"
],
"title": "The protocol Schema",
"type": "string"
}
},
"title": "A Schema",
"type": "object"
},
"title": "The ports Schema",
"type": "array"
},
"to": {
"default": [],
"examples": [
[
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
],
"items": {
"default": {},
"examples": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
],
"properties": {
"ipBlock": {
"default": {},
"examples": [
{
"cidr": "0.0.0.0/0"
}
],
"properties": {
"cidr": {
"default": "",
"examples": [
"0.0.0.0/0"
],
"title": "The cidr Schema",
"type": "string"
}
},
"title": "The ipBlock Schema",
"type": "object"
}
},
"title": "A Schema",
"type": "object"
},
"title": "The to Schema",
"type": "array"
}
},
"title": "A Schema",
"type": "object"
},
"title": "The egress Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"ingress": {
"default": [],
"examples": [
[
{
"from": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
]
],
"items": {
"default": {},
"examples": [
{
"from": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
}
],
"properties": {
"from": {
"default": [],
"examples": [
[
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
]
],
"items": {
"default": {},
"examples": [
{
"ipBlock": {
"cidr": "0.0.0.0/0"
}
}
],
"properties": {
"ipBlock": {
"default": {},
"examples": [
{
"cidr": "0.0.0.0/0"
}
],
"properties": {
"cidr": {
"default": "",
"examples": [
"0.0.0.0/0"
],
"title": "The cidr Schema",
"type": "string"
}
},
"title": "The ipBlock Schema",
"type": "object"
}
},
"title": "A Schema",
"type": "object"
},
"title": "The from Schema",
"type": "array"
}
},
"title": "A Schema",
"type": "object"
},
"title": "The ingress Schema",
"type": "array"
}
},
"title": "The networkPolicy Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{
"kubernetes.io/os": "linux"
}
],
"properties": {
"kubernetes.io/os": {
"default": "",
"examples": [
"linux"
],
"title": "The kubernetes.io/os Schema",
"type": "string"
}
},
"title": "The nodeSelector Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The podLabels Schema",
"type": "object"
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"initialDelaySeconds": 5,
"periodSeconds": 5,
"successThreshold": 1,
"timeoutSeconds": 1
}
],
"properties": {
"failureThreshold": {
"default": 0,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
5
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 0,
"examples": [
5
],
"title": "The periodSeconds Schema",
"type": "integer"
},
"successThreshold": {
"default": 0,
"examples": [
1
],
"title": "The successThreshold Schema",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
1
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"title": "The readinessProbe Schema",
"type": "object"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The resources Schema",
"type": "object"
},
"securePort": {
"default": 0,
"examples": [
10250
],
"title": "The securePort Schema",
"type": "integer"
},
"securityContext": {
"default": {},
"examples": [
{
"runAsNonRoot": true,
"seccompProfile": {
"type": "RuntimeDefault"
}
}
],
"properties": {
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"seccompProfile": {
"default": {},
"examples": [
{
"type": "RuntimeDefault"
}
],
"properties": {
"type": {
"default": "",
"examples": [
"RuntimeDefault"
],
"title": "The type Schema",
"type": "string"
}
},
"title": "The seccompProfile Schema",
"type": "object"
}
},
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"automountServiceAccountToken": true,
"create": true
}
],
"properties": {
"automountServiceAccountToken": {
"default": false,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The serviceLabels Schema",
"type": "object"
},
"serviceType": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "The serviceType Schema",
"type": "string"
},
"strategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The strategy Schema",
"type": "object"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"url": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The url Schema",
"type": "object"
}
},
"title": "The webhook Schema",
"type": "object"
}
},
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 64cffc5a869c8189d488160d803e6793edd792b2 | 2024-01-18T18:42:35 | projects/kubernetes-sigs/metrics-server/1-27/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "Annotations to add to the APIService",
"type": "object"
},
"caBundle": {
"default": "",
"examples": [
""
],
"title": "PEM encoded CA bundle for TLS verification",
"type": "string"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"insecureSkipTLSVerify": {
"default": true,
"examples": [
true
],
"title": "Specifies whether to skip TLS verification",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"commonLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The commonLabels Schema",
"type": "object"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"securityContext": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 10250,
"examples": [
10250
],
"title": "The containerPort Schema",
"type": "integer"
},
"default": {},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"drop": {
"default": [
"ALL"
],
"examples": [
[]
],
"items": {},
"title": "The drop Schema",
"type": "array"
}
},
"required": [],
"title": "The seccompProfile Schema",
"type": "object"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
},
"seccompProfile": {
"default": {},
"examples": [
{}
],
"properties": {
"type": {
"default": "RuntimeDefault",
"examples": [
"RuntimeDefault"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The seccompProfile Schema",
"type": "object"
}
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"required": [],
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"schedulerName": {
"default": "",
"examples": [],
"title": "The schedulerName Schema",
"type": "string"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The metricRelabelings Schema",
"type": "array"
},
"relabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The relabelings Schema",
"type": "array"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"title": "The securityContext Schema",
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"type": "object",
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
},
"secrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The list of secrets mountable by this service account",
"type": "array"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 25189db514f5e0c07e7a78016dd5ed13195e42fa | 2024-04-12T19:15:48 | projects/kubernetes-sigs/metrics-server/1-30/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"apiService": {
"create": true
},
"args": [],
"containerPort": 4443,
"defaultArgs": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"extraVolumeMounts": [],
"extraVolumes": [],
"fullnameOverride": "",
"hostNetwork": {
"enabled": false
},
"image": {
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
},
"imagePullSecrets": [],
"livenessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
},
"metrics": {
"enabled": false
},
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
},
"podLabels": {},
"podSecurityContext": {},
"priorityClassName": "system-cluster-critical",
"rbac": {
"create": true,
"pspEnabled": false
},
"readinessProbe": {
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
},
"replicas": 1,
"resources": {},
"securityContext": {
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
},
"service": {
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": ""
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"updateStrategy": {}
}
],
"properties": {
"apiService": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "Annotations to add to the APIService",
"type": "object"
},
"caBundle": {
"default": "",
"examples": [
""
],
"title": "PEM encoded CA bundle for TLS verification",
"type": "string"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"insecureSkipTLSVerify": {
"default": true,
"examples": [
true
],
"title": "Specifies whether to skip TLS verification",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The apiService Schema",
"type": "object"
},
"commonLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The commonLabels Schema",
"type": "object"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:46a80fd791bb08dfaa68728f50d086b09bd7a355cd0a16a075fd11eb876c2b80",
"pullPolicy": "IfNotPresent",
"repository": "metrics-server/eks-distro/kubernetes-sigs/metrics-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:21c7e2aea0555a9889021a50637c113bb7988922649bbed5634d4e95b5aa8b5d"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "metrics-server/eks-distro/kubernetes-sigs/metrics-server",
"examples": [
"metrics-server/eks-distro/kubernetes-sigs/metrics-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"pspEnabled": false
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The rbac Schema",
"type": "object"
},
"securityContext": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"args": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The args Schema",
"type": "array"
},
"containerPort": {
"default": 10250,
"examples": [
10250
],
"title": "The containerPort Schema",
"type": "integer"
},
"default": {},
"defaultArgs": {
"default": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"examples": [
[
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
]
],
"items": {
"examples": [
"--cert-dir=/tmp",
"--kubelet-preferred-address-types=InternalIP,ExternalIP,Hostname",
"--kubelet-use-node-status-port",
"--metric-resolution=15s"
],
"title": "A Schema",
"type": "string"
},
"title": "The defaultArgs Schema",
"type": "array"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"examples": [
{
"allowPrivilegeEscalation": false,
"readOnlyRootFilesystem": true,
"runAsNonRoot": true,
"runAsUser": 1000
}
],
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"hostNetwork": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The hostNetwork Schema",
"type": "object"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 0,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/livez",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/livez",
"examples": [
"/livez"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 0,
"examples": [
0
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"metrics": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The metrics Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enabled": false,
"maxUnavailable": null,
"minAvailable": null
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxUnavailable": {
"default": 1,
"examples": [
null
],
"title": "The maxUnavailable Schema",
"type": "integer"
},
"minAvailable": {
"default": 3,
"examples": [
null
],
"title": "The minAvailable Schema",
"type": "integer"
}
},
"required": [],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"priorityClassName": {
"default": "system-cluster-critical",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"properties": {
"allowPrivilegeEscalation": {
"default": false,
"examples": [
false
],
"title": "The allowPrivilegeEscalation Schema",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"drop": {
"default": [
"ALL"
],
"examples": [
[]
],
"items": {},
"title": "The drop Schema",
"type": "array"
}
},
"required": [],
"title": "The seccompProfile Schema",
"type": "object"
},
"readOnlyRootFilesystem": {
"default": true,
"examples": [
true
],
"title": "The readOnlyRootFilesystem Schema",
"type": "boolean"
},
"runAsNonRoot": {
"default": true,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 1000,
"examples": [
1000
],
"title": "The runAsUser Schema",
"type": "integer"
},
"seccompProfile": {
"default": {},
"examples": [
{}
],
"properties": {
"type": {
"default": "RuntimeDefault",
"examples": [
"RuntimeDefault"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The seccompProfile Schema",
"type": "object"
}
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
},
"initialDelaySeconds": 20,
"periodSeconds": 10
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"httpGet": {
"default": {},
"examples": [
{
"path": "/readyz",
"port": "https",
"scheme": "HTTPS"
}
],
"properties": {
"path": {
"default": "/readyz",
"examples": [
"/readyz"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": "https",
"examples": [
"https"
],
"title": "The port Schema",
"type": "string"
},
"scheme": {
"default": "HTTPS",
"examples": [
"HTTPS"
],
"title": "The scheme Schema",
"type": "string"
}
},
"required": [
"path",
"port",
"scheme"
],
"title": "The httpGet Schema",
"type": "object"
},
"initialDelaySeconds": {
"default": 20,
"examples": [
20
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 10,
"examples": [
10
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"required": [],
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"schedulerName": {
"default": "",
"examples": [],
"title": "The schedulerName Schema",
"type": "string"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"labels": {},
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "1m",
"scrapeTimeout": "10s"
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "1m",
"examples": [
"1m"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The metricRelabelings Schema",
"type": "array"
},
"relabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The relabelings Schema",
"type": "array"
},
"scrapeTimeout": {
"default": "10s",
"examples": [
"10s"
],
"title": "The scrapeTimeout Schema",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"title": "The securityContext Schema",
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"type": "object",
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
},
"secrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The list of secrets mountable by this service account",
"type": "array"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
}
},
"title": "Metrics Server",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 6edfaf6428dc197486cb0bd8e0371df1d67d6009 | 2023-04-28T18:48:29 | projects/kubernetes/autoscaler/1-27/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"additionalLabels": {},
"affinity": {},
"autoDiscovery": {
"clusterName": "my-cluster",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
},
"autoscalingGroups": [],
"autoscalingGroupsnamePrefix": [],
"awsAccessKeyID": "",
"awsRegion": "us-east-1",
"awsSecretAccessKey": "",
"azureClientID": "",
"azureClientSecret": "",
"azureClusterName": "",
"azureNodeResourceGroup": "",
"azureResourceGroup": "",
"azureSubscriptionID": "",
"azureTenantID": "",
"azureUseManagedIdentityExtension": false,
"azureVMType": "AKS",
"cloudConfigPath": "",
"cloudProvider": "clusterapi",
"clusterAPICloudConfigPath": "/etc/kubernetes/mgmt-kubeconfig",
"clusterAPIConfigMapsNamespace": "",
"clusterAPIKubeconfigSecret": "",
"clusterAPIMode": "incluster-incluster",
"clusterAPIWorkloadKubeconfigPath": "/etc/kubernetes/value",
"containerSecurityContext": {},
"deployment": {
"annotations": {}
},
"dnsPolicy": "ClusterFirst",
"envFromConfigMap": "",
"envFromSecret": "",
"expanderPriorities": {},
"extraArgs": {
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
},
"extraEnv": {},
"extraEnvConfigMaps": {},
"extraEnvSecrets": {},
"extraVolumeMounts": [],
"extraVolumeSecrets": {},
"extraVolumes": [],
"fullnameOverride": "",
"image": {
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
},
"imagePullSecrets": [],
"kubeTargetVersionOverride": "",
"magnumCABundlePath": "/etc/kubernetes/ca-bundle.crt",
"magnumClusterName": "",
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"maxUnavailable": 1
},
"podLabels": {},
"priorityClassName": "system-cluster-critical",
"priorityConfigMapAnnotations": {},
"prometheusRule": {
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
},
"rbac": {
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
},
"replicaCount": 1,
"resources": {},
"securityContext": {},
"service": {
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
},
"sourceRegistry": "public.ecr.aws",
"tolerations": [],
"topologySpreadConstraints": [],
"updateStrategy": {}
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"autoDiscovery": {
"default": {},
"examples": [
{
"clusterName": "my-cluster-name",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
}
],
"properties": {
"clusterName": {
"default": "",
"examples": [
"my-cluster-name"
],
"title": "The clusterName Schema",
"type": "string"
},
"labels": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The labels Schema",
"type": "array"
},
"roles": {
"default": [],
"examples": [
[
"worker"
]
],
"items": {
"default": "",
"examples": [
"worker"
],
"title": "A Schema",
"type": "string"
},
"title": "The roles Schema",
"type": "array"
},
"tags": {
"default": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"examples": [
[
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
],
"items": {
"examples": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"title": "A Schema",
"type": "string"
},
"title": "The tags Schema",
"type": "array"
}
},
"required": [],
"title": "The autoDiscovery Schema",
"type": "object"
},
"autoscalingGroups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroups Schema",
"type": "array"
},
"autoscalingGroupsnamePrefix": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroupsnamePrefix Schema",
"type": "array"
},
"awsAccessKeyID": {
"default": "",
"examples": [
""
],
"title": "The awsAccessKeyID Schema",
"type": "string"
},
"awsRegion": {
"default": "",
"examples": [
"us-east-1"
],
"title": "The awsRegion Schema",
"type": "string"
},
"awsSecretAccessKey": {
"default": "",
"examples": [
""
],
"title": "The awsSecretAccessKey Schema",
"type": "string"
},
"azureClientID": {
"default": "",
"examples": [
""
],
"title": "The azureClientID Schema",
"type": "string"
},
"azureClientSecret": {
"default": "",
"examples": [
""
],
"title": "The azureClientSecret Schema",
"type": "string"
},
"azureClusterName": {
"default": "",
"examples": [
""
],
"title": "The azureClusterName Schema",
"type": "string"
},
"azureNodeResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureNodeResourceGroup Schema",
"type": "string"
},
"azureResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureResourceGroup Schema",
"type": "string"
},
"azureSubscriptionID": {
"default": "",
"examples": [
""
],
"title": "The azureSubscriptionID Schema",
"type": "string"
},
"azureTenantID": {
"default": "",
"examples": [
""
],
"title": "The azureTenantID Schema",
"type": "string"
},
"azureUseManagedIdentityExtension": {
"default": false,
"examples": [
false
],
"title": "The azureUseManagedIdentityExtension Schema",
"type": "boolean"
},
"azureVMType": {
"default": "",
"examples": [
"AKS"
],
"title": "The azureVMType Schema",
"type": "string"
},
"cloudConfigPath": {
"default": "",
"examples": [
""
],
"title": "The cloudConfigPath Schema",
"type": "string"
},
"cloudProvider": {
"default": "",
"examples": [
"clusterapi"
],
"title": "The cloudProvider Schema",
"type": "string"
},
"clusterAPICloudConfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/mgmt-kubeconfig"
],
"title": "The clusterAPICloudConfigPath Schema",
"type": "string"
},
"clusterAPIConfigMapsNamespace": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIConfigMapsNamespace Schema",
"type": "string"
},
"clusterAPIKubeconfigSecret": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIKubeconfigSecret Schema",
"type": "string"
},
"clusterAPIMode": {
"default": "",
"examples": [
"incluster-incluster"
],
"title": "The clusterAPIMode Schema",
"type": "string"
},
"clusterAPIWorkloadKubeconfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/value"
],
"title": "The clusterAPIWorkloadKubeconfigPath Schema",
"type": "string"
},
"containerSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The containerSecurityContext Schema",
"type": "object"
},
"deployment": {
"default": {},
"examples": [
{
"annotations": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
}
},
"required": [
"annotations"
],
"title": "The deployment Schema",
"type": "object"
},
"dnsPolicy": {
"default": "",
"examples": [
"ClusterFirst"
],
"title": "The dnsPolicy Schema",
"type": "string"
},
"envFromConfigMap": {
"default": "",
"examples": [
""
],
"title": "The envFromConfigMap Schema",
"type": "string"
},
"envFromSecret": {
"default": "",
"examples": [
""
],
"title": "The envFromSecret Schema",
"type": "string"
},
"expanderPriorities": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The expanderPriorities Schema",
"type": "object"
},
"extraArgs": {
"default": {},
"examples": [
{
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
}
],
"properties": {
"logtostderr": {
"default": true,
"examples": [
true
],
"title": "The logtostderr Schema",
"type": "boolean"
},
"stderrthreshold": {
"default": "info",
"examples": [
"info"
],
"title": "The stderrthreshold Schema",
"type": "string"
},
"v": {
"default": 4,
"examples": [
4
],
"title": "The v Schema",
"type": "integer"
}
},
"required": [],
"title": "The extraArgs Schema",
"type": "object"
},
"extraEnv": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnv Schema",
"type": "object"
},
"extraEnvConfigMaps": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvConfigMaps Schema",
"type": "object"
},
"extraEnvSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvSecrets Schema",
"type": "object"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumeSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraVolumeSecrets Schema",
"type": "object"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "kubernetes/autoscaler",
"examples": [
"kubernetes/autoscaler"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeTargetVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeTargetVersionOverride Schema",
"type": "string"
},
"magnumCABundlePath": {
"default": "",
"examples": [
"/etc/kubernetes/ca-bundle.crt"
],
"title": "The magnumCABundlePath Schema",
"type": "string"
},
"magnumClusterName": {
"default": "",
"examples": [
""
],
"title": "The magnumClusterName Schema",
"type": "string"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"maxUnavailable": 1
}
],
"properties": {
"maxUnavailable": {
"default": 1,
"examples": [
1
],
"title": "The maxUnavailable Schema",
"type": "integer"
}
},
"required": [
"maxUnavailable"
],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"priorityConfigMapAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The priorityConfigMapAnnotations Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"rules": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The rules Schema",
"type": "array"
}
},
"required": [],
"title": "The prometheusRule Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
}
],
"properties": {
"clusterScoped": {
"default": true,
"examples": [
true
],
"title": "The clusterScoped Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"externalIPs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The externalIPs Schema",
"type": "array"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"loadBalancerIP": {
"default": "",
"examples": [
""
],
"title": "The loadBalancerIP Schema",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The loadBalancerSourceRanges Schema",
"type": "array"
},
"portName": {
"default": "http",
"examples": [
"http"
],
"title": "The portName Schema",
"type": "string"
},
"servicePort": {
"default": 8085,
"examples": [
8085
],
"title": "The servicePort Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The metricRelabelings Schema",
"type": "object"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"selector": {
"default": {},
"examples": [
{
"release": "prometheus-operator"
}
],
"properties": {
"release": {
"default": "prometheus-operator",
"examples": [
"prometheus-operator"
],
"title": "The release Schema",
"type": "string"
}
},
"required": [],
"title": "The selector Schema",
"type": "object"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 9b51b8b642f5b8b539213bd88dacac5c5aa2573b | 2023-03-02T21:25:01 | projects/goharbor/harbor/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"caSecretName": "",
"cache": {
"enabled": false,
"expireHours": 24
},
"chartmuseum": {
"absoluteUrl": false,
"affinity": {},
"automountServiceAccountToken": false,
"enabled": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
},
"indexLimit": 0,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"core": {
"affinity": {},
"artifactPullAsyncFlushDuration": null,
"automountServiceAccountToken": false,
"gdpr": {
"deleteUser": false
},
"image": {
"digest": "sha256:a23c6c301ab4cd5f9b88084b0573977017f6212fc57e4eea2ccfea5842394d69",
"repository": "harbor/harbor-core"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"secretName": "",
"serviceAccountName": "",
"serviceAnnotations": {},
"startupProbe": {
"enabled": true,
"initialDelaySeconds": 10
},
"tokenCert": "",
"tokenKey": "",
"tolerations": [],
"xsrfKey": ""
},
"database": {
"external": {
"coreDatabase": "registry",
"existingSecret": "",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:ccc4e6038c9b705cccee719a8783bae40a2f5e0404065680b782f859519c12ee",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"livenessProbe": {
"timeoutSeconds": 1
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"readinessProbe": {
"timeoutSeconds": 1
},
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
},
"maxIdleConns": 100,
"maxOpenConns": 900,
"podAnnotations": {},
"type": "internal"
},
"defaultNamespace": "harbor",
"enableMigrateHelmHook": false,
"existingSecretSecretKey": "",
"exporter": {
"affinity": {},
"automountServiceAccountToken": false,
"cacheCleanInterval": 14400,
"cacheDuration": 23,
"image": {
"digest": "sha256:1ef3ebe9040ac348cdc6ba080f63815c3d6fe3be08e0ba3d0d3e0790b86d946a",
"repository": "harbor/harbor-exporter"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"expose": {
"clusterIP": {
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
},
"ingress": {
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
},
"loadBalancer": {
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
},
"nodePort": {
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
},
"tls": {
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
},
"type": "nodePort"
},
"externalURL": "https://127.0.0.1:30003",
"harborAdminPassword": "Harbor12345",
"imageCredentials": {
"email": "",
"password": "",
"registry": "",
"username": ""
},
"imagePullPolicy": "IfNotPresent",
"imagePullSecrets": null,
"internalTLS": {
"certSource": "auto",
"chartmuseum": {
"crt": "",
"key": "",
"secretName": ""
},
"core": {
"crt": "",
"key": "",
"secretName": ""
},
"enabled": true,
"jobservice": {
"crt": "",
"key": "",
"secretName": ""
},
"portal": {
"crt": "",
"key": "",
"secretName": ""
},
"registry": {
"crt": "",
"key": "",
"secretName": ""
},
"trivy": {
"crt": "",
"key": "",
"secretName": ""
},
"trustCa": ""
},
"ipFamily": {
"ipv4": {
"enabled": true
},
"ipv6": {
"enabled": true
}
},
"jobservice": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:1c83a149511db1cc715c6195da5e8c5ab57008285fa76fb85baefd696dc2dfa1",
"repository": "harbor/harbor-jobservice"
},
"jobLoggers": [
"file"
],
"loggerSweeperDuration": 14,
"maxJobWorkers": 10,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": []
},
"logLevel": "info",
"metrics": {
"core": {
"path": "/metrics",
"port": 8001
},
"enabled": false,
"exporter": {
"path": "/metrics",
"port": 8001
},
"jobservice": {
"path": "/metrics",
"port": 8001
},
"registry": {
"path": "/metrics",
"port": 8001
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
},
"nginx": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:14825e3211b9e2d21f09dcac4b42a64d1b511cfbf9cb187da69b89f9189d23a7",
"repository": "harbor/harbor-nginx"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"notary": {
"enabled": false,
"secretName": "",
"server": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
},
"serviceAnnotations": {},
"signer": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
},
"persistence": {
"enabled": true,
"imageChartStorage": {
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername",
"existingSecret": ""
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file",
"existingSecret": "",
"useWorkloadIdentity": false
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
},
"persistentVolumeClaim": {
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"jobLog": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
},
"resourcePolicy": "keep"
},
"portal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:57eaec7d5bf9aa8cd7a63b84cb4542110a4fe444870be46a39e0e7f065e1cf55",
"repository": "harbor/harbor-portal"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
},
"proxy": {
"components": [
"core",
"jobservice",
"trivy"
],
"httpProxy": null,
"httpsProxy": null,
"noProxy": "127.0.0.1,localhost,.local,.internal"
},
"pullSecretData": "",
"pullSecretName": "",
"redis": {
"external": {
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"existingSecret": "",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:5fda938e140f7f098b776d520e5a8c4d9ce82b3785d9c6a465bcd533be88dfa9",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
},
"podAnnotations": {},
"type": "internal"
},
"registry": {
"affinity": {},
"automountServiceAccountToken": false,
"controller": {
"image": {
"digest": "sha256:23552e406330014525f678a840d4b66dae145d28b29ab33dca17570b16329b24",
"repository": "harbor/harbor-registryctl"
}
},
"credentials": {
"existingSecret": "",
"password": "harbor_registry_password",
"username": "harbor_registry_user"
},
"middleware": {
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"registry": {
"image": {
"digest": "sha256:b120d0748fb9a8cd74bbfcd99a9520fab9543f3e770d1e76ac6be99e08dceb99",
"repository": "harbor/harbor-registry"
}
},
"relativeurls": true,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": [],
"upload_purging": {
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
},
"secretKey": "",
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"trace": {
"enabled": false,
"jaeger": {
"endpoint": "http://hostname:14268/api/traces"
},
"otel": {
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": 10,
"url_path": "/v1/traces"
},
"provider": "jaeger",
"sample_rate": 1
},
"trivy": {
"affinity": {},
"automountServiceAccountToken": false,
"debugMode": false,
"enabled": true,
"gitHubToken": "",
"ignoreUnfixed": false,
"image": {
"digest": "sha256:84d2a9de23541ca792e2d0e54e01d4ef4ad1205ea5aa942e342cd9bab1c98f2d",
"repository": "harbor/harbor-trivy"
},
"insecure": false,
"nodeSelector": {},
"offlineScan": false,
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"resources": {
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
},
"securityCheck": "vuln",
"serviceAccountName": "",
"severity": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"skipUpdate": false,
"timeout": "5m0s",
"tolerations": [],
"vulnType": "os,library"
},
"updateStrategy": {
"type": "Recreate"
}
}
],
"properties": {
"caSecretName": {
"default": "",
"examples": [
""
],
"title": "The caSecretName Schema",
"type": "string"
},
"cache": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false,
"expireHours": 24
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"expireHours": {
"default": 24,
"examples": [
24
],
"title": "The expireHours Schema",
"type": "integer"
}
},
"required": [],
"title": "The cache Schema",
"type": "object"
},
"chartmuseum": {
"additionalProperties": false,
"default": {},
"examples": [
{
"absoluteUrl": false,
"affinity": {},
"automountServiceAccountToken": false,
"enabled": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
},
"indexLimit": 0,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"absoluteUrl": {
"default": false,
"examples": [
false
],
"title": "The absoluteUrl Schema",
"type": "boolean"
},
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-chartmuseum"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-chartmuseum",
"examples": [
"harbor/harbor-chartmuseum"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"indexLimit": {
"default": 0,
"examples": [
0
],
"title": "The indexLimit Schema",
"type": "integer"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The chartmuseum Schema",
"type": "object"
},
"core": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"artifactPullAsyncFlushDuration": null,
"automountServiceAccountToken": false,
"gdpr": {
"deleteUser": false
},
"image": {
"digest": "sha256:a23c6c301ab4cd5f9b88084b0573977017f6212fc57e4eea2ccfea5842394d69",
"repository": "harbor/harbor-core"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"secretName": "",
"serviceAccountName": "",
"serviceAnnotations": {},
"startupProbe": {
"enabled": true,
"initialDelaySeconds": 10
},
"tokenCert": "",
"tokenKey": "",
"tolerations": [],
"xsrfKey": ""
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"artifactPullAsyncFlushDuration": {
"default": null,
"examples": [
null
],
"title": "The artifactPullAsyncFlushDuration Schema",
"type": "null"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"gdpr": {
"additionalProperties": false,
"default": {},
"examples": [
{
"deleteUser": false
}
],
"properties": {
"deleteUser": {
"default": false,
"examples": [
false
],
"title": "The deleteUser Schema",
"type": "boolean"
}
},
"required": [],
"title": "The gdpr Schema",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:a23c6c301ab4cd5f9b88084b0573977017f6212fc57e4eea2ccfea5842394d69",
"repository": "harbor/harbor-core"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:a23c6c301ab4cd5f9b88084b0573977017f6212fc57e4eea2ccfea5842394d69"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-core",
"examples": [
"harbor/harbor-core"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"serviceAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"startupProbe": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"initialDelaySeconds": 10
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"initialDelaySeconds": {
"default": 10,
"examples": [
10
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The startupProbe Schema",
"type": "object"
},
"tokenCert": {
"default": "",
"examples": [
""
],
"title": "The tokenCert Schema",
"type": "string"
},
"tokenKey": {
"default": "",
"examples": [
""
],
"title": "The tokenKey Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"xsrfKey": {
"default": "",
"examples": [
""
],
"title": "The xsrfKey Schema",
"type": "string"
}
},
"required": [],
"title": "The core Schema",
"type": "object"
},
"database": {
"additionalProperties": false,
"default": {},
"examples": [
{
"external": {
"coreDatabase": "registry",
"existingSecret": "",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:ccc4e6038c9b705cccee719a8783bae40a2f5e0404065680b782f859519c12ee",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"livenessProbe": {
"timeoutSeconds": 1
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"readinessProbe": {
"timeoutSeconds": 1
},
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
},
"maxIdleConns": 100,
"maxOpenConns": 900,
"podAnnotations": {},
"type": "internal"
}
],
"properties": {
"external": {
"additionalProperties": false,
"default": {},
"examples": [
{
"coreDatabase": "registry",
"existingSecret": "",
"host": "192.168.0.1",
"notaryServerDatabase": "notary_server",
"notarySignerDatabase": "notary_signer",
"password": "password",
"port": "5432",
"sslmode": "disable",
"username": "user"
}
],
"properties": {
"coreDatabase": {
"default": "registry",
"examples": [
"registry"
],
"title": "The coreDatabase Schema",
"type": "string"
},
"existingSecret": {
"default": "",
"examples": [
""
],
"title": "The existingSecret Schema",
"type": "string"
},
"host": {
"default": "192.168.0.1",
"examples": [
"192.168.0.1"
],
"title": "The host Schema",
"type": "string"
},
"notaryServerDatabase": {
"default": "notary_server",
"examples": [
"notary_server"
],
"title": "The notaryServerDatabase Schema",
"type": "string"
},
"notarySignerDatabase": {
"default": "notary_signer",
"examples": [
"notary_signer"
],
"title": "The notarySignerDatabase Schema",
"type": "string"
},
"password": {
"default": "password",
"examples": [
"password"
],
"title": "The password Schema",
"type": "string"
},
"port": {
"default": "5432",
"examples": [
"5432"
],
"title": "The port Schema",
"type": "string"
},
"sslmode": {
"default": "disable",
"examples": [
"disable"
],
"title": "The sslmode Schema",
"type": "string"
},
"username": {
"default": "user",
"examples": [
"user"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [],
"title": "The external Schema",
"type": "object"
},
"internal": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:ccc4e6038c9b705cccee719a8783bae40a2f5e0404065680b782f859519c12ee",
"repository": "harbor/harbor-db"
},
"initContainer": {
"migrator": {},
"permissions": {}
},
"livenessProbe": {
"timeoutSeconds": 1
},
"nodeSelector": {},
"password": "changeit",
"priorityClassName": null,
"readinessProbe": {
"timeoutSeconds": 1
},
"serviceAccountName": "",
"shmSizeLimit": "512Mi",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:ccc4e6038c9b705cccee719a8783bae40a2f5e0404065680b782f859519c12ee",
"repository": "harbor/harbor-db"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:ccc4e6038c9b705cccee719a8783bae40a2f5e0404065680b782f859519c12ee"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-db",
"examples": [
"harbor/harbor-db"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"initContainer": {
"additionalProperties": false,
"default": {},
"examples": [
{
"migrator": {},
"permissions": {}
}
],
"properties": {
"migrator": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The migrator Schema",
"type": "object"
},
"permissions": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The permissions Schema",
"type": "object"
}
},
"required": [],
"title": "The initContainer Schema",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"default": {},
"examples": [
{
"timeoutSeconds": 1
}
],
"properties": {
"timeoutSeconds": {
"default": 1,
"examples": [
1
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The livenessProbe Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"password": {
"default": "changeit",
"examples": [
"changeit"
],
"title": "The password Schema",
"type": "string"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"readinessProbe": {
"additionalProperties": false,
"default": {},
"examples": [
{
"timeoutSeconds": 1
}
],
"properties": {
"timeoutSeconds": {
"default": 1,
"examples": [
1
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [],
"title": "The readinessProbe Schema",
"type": "object"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"shmSizeLimit": {
"default": "512Mi",
"examples": [
"512Mi"
],
"title": "The shmSizeLimit Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The internal Schema",
"type": "object"
},
"maxIdleConns": {
"default": 100,
"examples": [
100
],
"title": "The maxIdleConns Schema",
"type": "integer"
},
"maxOpenConns": {
"default": 900,
"examples": [
900
],
"title": "The maxOpenConns Schema",
"type": "integer"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"type": {
"default": "internal",
"examples": [
"internal"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The database Schema",
"type": "object"
},
"defaultNamespace": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The defaultNamespace Schema",
"type": "string"
},
"enableMigrateHelmHook": {
"default": false,
"examples": [
false
],
"title": "The enableMigrateHelmHook Schema",
"type": "boolean"
},
"existingSecretSecretKey": {
"default": "",
"examples": [
""
],
"title": "The existingSecretSecretKey Schema",
"type": "string"
},
"exporter": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"cacheCleanInterval": 14400,
"cacheDuration": 23,
"image": {
"digest": "sha256:1ef3ebe9040ac348cdc6ba080f63815c3d6fe3be08e0ba3d0d3e0790b86d946a",
"repository": "harbor/harbor-exporter"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"cacheCleanInterval": {
"default": 14400,
"examples": [
14400
],
"title": "The cacheCleanInterval Schema",
"type": "integer"
},
"cacheDuration": {
"default": 23,
"examples": [
23
],
"title": "The cacheDuration Schema",
"type": "integer"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:1ef3ebe9040ac348cdc6ba080f63815c3d6fe3be08e0ba3d0d3e0790b86d946a",
"repository": "harbor/harbor-exporter"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:1ef3ebe9040ac348cdc6ba080f63815c3d6fe3be08e0ba3d0d3e0790b86d946a"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-exporter",
"examples": [
"harbor/harbor-exporter"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The exporter Schema",
"type": "object"
},
"expose": {
"additionalProperties": false,
"default": {},
"examples": [
{
"clusterIP": {
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
},
"ingress": {
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
},
"loadBalancer": {
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
},
"nodePort": {
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
},
"tls": {
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
},
"type": "nodePort"
}
],
"properties": {
"clusterIP": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
}
],
"properties": {
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
],
"properties": {
"httpPort": {
"default": 80,
"examples": [
80
],
"title": "The httpPort Schema",
"type": "integer"
},
"httpsPort": {
"default": 443,
"examples": [
443
],
"title": "The httpsPort Schema",
"type": "integer"
},
"notaryPort": {
"default": 4443,
"examples": [
4443
],
"title": "The notaryPort Schema",
"type": "integer"
}
},
"required": [],
"title": "The ports Schema",
"type": "object"
}
},
"required": [],
"title": "The clusterIP Schema",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
},
"className": "",
"controller": "default",
"harbor": {
"annotations": {},
"labels": {}
},
"hosts": {
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
},
"kubeVersionOverride": "",
"notary": {
"annotations": {},
"labels": {}
}
}
],
"properties": {
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ingress.kubernetes.io/proxy-body-size": "0",
"ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/proxy-body-size": "0",
"nginx.ingress.kubernetes.io/ssl-redirect": "true"
}
],
"properties": {
"ingress.kubernetes.io/proxy-body-size": {
"default": "0",
"examples": [
"0"
],
"title": "The ingress.kubernetes.io/proxy-body-size Schema",
"type": "string"
},
"ingress.kubernetes.io/ssl-redirect": {
"default": "true",
"examples": [
"true"
],
"title": "The ingress.kubernetes.io/ssl-redirect Schema",
"type": "string"
},
"nginx.ingress.kubernetes.io/proxy-body-size": {
"default": "0",
"examples": [
"0"
],
"title": "The nginx.ingress.kubernetes.io/proxy-body-size Schema",
"type": "string"
},
"nginx.ingress.kubernetes.io/ssl-redirect": {
"default": "true",
"examples": [
"true"
],
"title": "The nginx.ingress.kubernetes.io/ssl-redirect Schema",
"type": "string"
}
},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"className": {
"default": "",
"examples": [
""
],
"title": "The className Schema",
"type": "string"
},
"controller": {
"default": "default",
"examples": [
"default"
],
"title": "The controller Schema",
"type": "string"
},
"harbor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"labels": {}
}
],
"properties": {
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
}
},
"required": [],
"title": "The harbor Schema",
"type": "object"
},
"hosts": {
"additionalProperties": false,
"default": {},
"examples": [
{
"core": "core.harbor.domain",
"notary": "notary.harbor.domain"
}
],
"properties": {
"core": {
"default": "core.harbor.domain",
"examples": [
"core.harbor.domain"
],
"title": "The core Schema",
"type": "string"
},
"notary": {
"default": "notary.harbor.domain",
"examples": [
"notary.harbor.domain"
],
"title": "The notary Schema",
"type": "string"
}
},
"required": [],
"title": "The hosts Schema",
"type": "object"
},
"kubeVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeVersionOverride Schema",
"type": "string"
},
"notary": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"labels": {}
}
],
"properties": {
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"labels": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
}
},
"required": [],
"title": "The notary Schema",
"type": "object"
}
},
"required": [],
"title": "The ingress Schema",
"type": "object"
},
"loadBalancer": {
"additionalProperties": false,
"default": {},
"examples": [
{
"IP": "",
"annotations": {},
"name": "harbor",
"ports": {
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
},
"sourceRanges": []
}
],
"properties": {
"IP": {
"default": "",
"examples": [
""
],
"title": "The IP Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"httpPort": 80,
"httpsPort": 443,
"notaryPort": 4443
}
],
"properties": {
"httpPort": {
"default": 80,
"examples": [
80
],
"title": "The httpPort Schema",
"type": "integer"
},
"httpsPort": {
"default": 443,
"examples": [
443
],
"title": "The httpsPort Schema",
"type": "integer"
},
"notaryPort": {
"default": 4443,
"examples": [
4443
],
"title": "The notaryPort Schema",
"type": "integer"
}
},
"required": [],
"title": "The ports Schema",
"type": "object"
},
"sourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The sourceRanges Schema",
"type": "array"
}
},
"required": [],
"title": "The loadBalancer Schema",
"type": "object"
},
"nodePort": {
"additionalProperties": false,
"default": {},
"examples": [
{
"name": "harbor",
"ports": {
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
}
],
"properties": {
"name": {
"default": "harbor",
"examples": [
"harbor"
],
"title": "The name Schema",
"type": "string"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"http": {
"nodePort": 30002,
"port": 80
},
"https": {
"nodePort": 30003,
"port": 443
},
"notary": {
"nodePort": 30004,
"port": 4443
}
}
],
"properties": {
"http": {
"additionalProperties": false,
"default": {},
"examples": [
{
"nodePort": 30002,
"port": 80
}
],
"properties": {
"nodePort": {
"default": 30002,
"examples": [
30002
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 80,
"examples": [
80
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The http Schema",
"type": "object"
},
"https": {
"additionalProperties": false,
"default": {},
"examples": [
{
"nodePort": 30003,
"port": 443
}
],
"properties": {
"nodePort": {
"default": 30003,
"examples": [
30003
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The https Schema",
"type": "object"
},
"notary": {
"additionalProperties": false,
"default": {},
"examples": [
{
"nodePort": 30004,
"port": 4443
}
],
"properties": {
"nodePort": {
"default": 30004,
"examples": [
30004
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 4443,
"examples": [
4443
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The notary Schema",
"type": "object"
}
},
"required": [],
"title": "The ports Schema",
"type": "object"
}
},
"required": [],
"title": "The nodePort Schema",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"examples": [
{
"auto": {
"commonName": ""
},
"certSource": "secret",
"enabled": true,
"secret": {
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
}
],
"properties": {
"auto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"commonName": ""
}
],
"properties": {
"commonName": {
"default": "",
"examples": [
""
],
"title": "The commonName Schema",
"type": "string"
}
},
"required": [],
"title": "The auto Schema",
"type": "object"
},
"certSource": {
"default": "secret",
"examples": [
"secret"
],
"title": "The certSource Schema",
"type": "string"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"secret": {
"additionalProperties": false,
"default": {},
"examples": [
{
"notarySecretName": "",
"secretName": "harbor-tls-secret"
}
],
"properties": {
"notarySecretName": {
"default": "",
"examples": [
""
],
"title": "The notarySecretName Schema",
"type": "string"
},
"secretName": {
"default": "harbor-tls-secret",
"examples": [
"harbor-tls-secret"
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The secret Schema",
"type": "object"
}
},
"required": [],
"title": "The tls Schema",
"type": "object"
},
"type": {
"default": "nodePort",
"examples": [
"nodePort"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The expose Schema",
"type": "object"
},
"externalURL": {
"default": "https://127.0.0.1:30003",
"examples": [
"https://127.0.0.1:30003"
],
"title": "The externalURL Schema",
"type": "string"
},
"harborAdminPassword": {
"default": "Harbor12345",
"examples": [
"Harbor12345"
],
"title": "The harborAdminPassword Schema",
"type": "string"
},
"imageCredentials": {
"additionalProperties": false,
"default": {},
"examples": [
{
"email": "",
"password": "",
"registry": "",
"username": ""
}
],
"properties": {
"email": {
"default": "",
"examples": [
""
],
"title": "The email Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
""
],
"title": "The password Schema",
"type": "string"
},
"registry": {
"default": "",
"examples": [
""
],
"title": "The registry Schema",
"type": "string"
},
"username": {
"default": "",
"examples": [
""
],
"title": "The username Schema",
"type": "string"
}
},
"required": [],
"title": "The imageCredentials Schema",
"type": "object"
},
"imagePullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The imagePullPolicy Schema",
"type": "string"
},
"imagePullSecrets": {
"default": null,
"examples": [
null
],
"title": "The imagePullSecrets Schema",
"type": "null"
},
"internalTLS": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certSource": "auto",
"chartmuseum": {
"crt": "",
"key": "",
"secretName": ""
},
"core": {
"crt": "",
"key": "",
"secretName": ""
},
"enabled": true,
"jobservice": {
"crt": "",
"key": "",
"secretName": ""
},
"portal": {
"crt": "",
"key": "",
"secretName": ""
},
"registry": {
"crt": "",
"key": "",
"secretName": ""
},
"trivy": {
"crt": "",
"key": "",
"secretName": ""
},
"trustCa": ""
}
],
"properties": {
"certSource": {
"default": "auto",
"examples": [
"auto"
],
"title": "The certSource Schema",
"type": "string"
},
"chartmuseum": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The chartmuseum Schema",
"type": "object"
},
"core": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The core Schema",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"jobservice": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The jobservice Schema",
"type": "object"
},
"portal": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The portal Schema",
"type": "object"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"trivy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crt": "",
"key": "",
"secretName": ""
}
],
"properties": {
"crt": {
"default": "",
"examples": [
""
],
"title": "The crt Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
}
},
"required": [],
"title": "The trivy Schema",
"type": "object"
},
"trustCa": {
"default": "",
"examples": [
""
],
"title": "The trustCa Schema",
"type": "string"
}
},
"required": [],
"title": "The internalTLS Schema",
"type": "object"
},
"ipFamily": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ipv4": {
"enabled": true
},
"ipv6": {
"enabled": true
}
}
],
"properties": {
"ipv4": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The ipv4 Schema",
"type": "object"
},
"ipv6": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [],
"title": "The ipv6 Schema",
"type": "object"
}
},
"required": [],
"title": "The ipFamily Schema",
"type": "object"
},
"jobservice": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:1c83a149511db1cc715c6195da5e8c5ab57008285fa76fb85baefd696dc2dfa1",
"repository": "harbor/harbor-jobservice"
},
"jobLoggers": [
"file"
],
"loggerSweeperDuration": 14,
"maxJobWorkers": 10,
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:1c83a149511db1cc715c6195da5e8c5ab57008285fa76fb85baefd696dc2dfa1",
"repository": "harbor/harbor-jobservice"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:1c83a149511db1cc715c6195da5e8c5ab57008285fa76fb85baefd696dc2dfa1"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-jobservice",
"examples": [
"harbor/harbor-jobservice"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"jobLoggers": {
"default": [],
"examples": [
[
"file"
]
],
"items": {
"default": "file",
"examples": [
"file"
],
"title": "A Schema",
"type": "string"
},
"title": "The jobLoggers Schema",
"type": "array"
},
"loggerSweeperDuration": {
"default": 14,
"examples": [
14
],
"title": "The loggerSweeperDuration Schema",
"type": "integer"
},
"maxJobWorkers": {
"default": 10,
"examples": [
10
],
"title": "The maxJobWorkers Schema",
"type": "integer"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The jobservice Schema",
"type": "object"
},
"logLevel": {
"default": "info",
"examples": [
"info"
],
"title": "The logLevel Schema",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"default": {},
"examples": [
{
"core": {
"path": "/metrics",
"port": 8001
},
"enabled": false,
"exporter": {
"path": "/metrics",
"port": 8001
},
"jobservice": {
"path": "/metrics",
"port": 8001
},
"registry": {
"path": "/metrics",
"port": 8001
},
"serviceMonitor": {
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
}
],
"properties": {
"core": {
"additionalProperties": false,
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The core Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"exporter": {
"additionalProperties": false,
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The exporter Schema",
"type": "object"
},
"jobservice": {
"additionalProperties": false,
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The jobservice Schema",
"type": "object"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"path": "/metrics",
"port": 8001
}
],
"properties": {
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"port": {
"default": 8001,
"examples": [
8001
],
"title": "The port Schema",
"type": "integer"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "",
"metricRelabelings": [],
"relabelings": []
}
],
"properties": {
"additionalLabels": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "",
"examples": [
""
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The metricRelabelings Schema",
"type": "array"
},
"relabelings": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The relabelings Schema",
"type": "array"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
}
},
"required": [],
"title": "The metrics Schema",
"type": "object"
},
"nginx": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:14825e3211b9e2d21f09dcac4b42a64d1b511cfbf9cb187da69b89f9189d23a7",
"repository": "harbor/harbor-nginx"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:14825e3211b9e2d21f09dcac4b42a64d1b511cfbf9cb187da69b89f9189d23a7",
"repository": "harbor/harbor-nginx"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:14825e3211b9e2d21f09dcac4b42a64d1b511cfbf9cb187da69b89f9189d23a7"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-nginx",
"examples": [
"harbor/harbor-nginx"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The nginx Schema",
"type": "object"
},
"notary": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false,
"secretName": "",
"server": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
},
"serviceAnnotations": {},
"signer": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"server": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-server"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-notary-server",
"examples": [
"harbor/harbor-notary-server"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The server Schema",
"type": "object"
},
"serviceAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"signer": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc",
"repository": "harbor/harbor-notary-signer"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:f5ac705ce6173725ac2f9da9891d13f1000e78caddbeca36e8c1c5b12e0f86fc"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-notary-signer",
"examples": [
"harbor/harbor-notary-signer"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The signer Schema",
"type": "object"
}
},
"required": [],
"title": "The notary Schema",
"type": "object"
},
"persistence": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"imageChartStorage": {
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername",
"existingSecret": ""
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file",
"existingSecret": "",
"useWorkloadIdentity": false
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
},
"persistentVolumeClaim": {
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"jobLog": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
},
"resourcePolicy": "keep"
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"imageChartStorage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"azure": {
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername",
"existingSecret": ""
},
"disableredirect": false,
"filesystem": {
"rootdirectory": "/storage"
},
"gcs": {
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file",
"existingSecret": "",
"useWorkloadIdentity": false
},
"oss": {
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
},
"s3": {
"bucket": "bucketname",
"region": "us-west-1"
},
"swift": {
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
},
"type": "filesystem"
}
],
"properties": {
"azure": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accountkey": "base64encodedaccountkey",
"accountname": "accountname",
"container": "containername",
"existingSecret": ""
}
],
"properties": {
"accountkey": {
"default": "base64encodedaccountkey",
"examples": [
"base64encodedaccountkey"
],
"title": "The accountkey Schema",
"type": "string"
},
"accountname": {
"default": "accountname",
"examples": [
"accountname"
],
"title": "The accountname Schema",
"type": "string"
},
"container": {
"default": "containername",
"examples": [
"containername"
],
"title": "The container Schema",
"type": "string"
},
"existingSecret": {
"default": "",
"examples": [
""
],
"title": "The existingSecret Schema",
"type": "string"
}
},
"required": [],
"title": "The azure Schema",
"type": "object"
},
"disableredirect": {
"default": false,
"examples": [
false
],
"title": "The disableredirect Schema",
"type": "boolean"
},
"filesystem": {
"additionalProperties": false,
"default": {},
"examples": [
{
"rootdirectory": "/storage"
}
],
"properties": {
"rootdirectory": {
"default": "/storage",
"examples": [
"/storage"
],
"title": "The rootdirectory Schema",
"type": "string"
}
},
"required": [],
"title": "The filesystem Schema",
"type": "object"
},
"gcs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"bucket": "bucketname",
"encodedkey": "base64-encoded-json-key-file",
"existingSecret": "",
"useWorkloadIdentity": false
}
],
"properties": {
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"encodedkey": {
"default": "base64-encoded-json-key-file",
"examples": [
"base64-encoded-json-key-file"
],
"title": "The encodedkey Schema",
"type": "string"
},
"existingSecret": {
"default": "",
"examples": [
""
],
"title": "The existingSecret Schema",
"type": "string"
},
"useWorkloadIdentity": {
"default": false,
"examples": [
false
],
"title": "The useWorkloadIdentity Schema",
"type": "boolean"
}
},
"required": [],
"title": "The gcs Schema",
"type": "object"
},
"oss": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accesskeyid": "accesskeyid",
"accesskeysecret": "accesskeysecret",
"bucket": "bucketname",
"region": "regionname"
}
],
"properties": {
"accesskeyid": {
"default": "accesskeyid",
"examples": [
"accesskeyid"
],
"title": "The accesskeyid Schema",
"type": "string"
},
"accesskeysecret": {
"default": "accesskeysecret",
"examples": [
"accesskeysecret"
],
"title": "The accesskeysecret Schema",
"type": "string"
},
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"region": {
"default": "regionname",
"examples": [
"regionname"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [],
"title": "The oss Schema",
"type": "object"
},
"s3": {
"additionalProperties": false,
"default": {},
"examples": [
{
"bucket": "bucketname",
"region": "us-west-1"
}
],
"properties": {
"bucket": {
"default": "bucketname",
"examples": [
"bucketname"
],
"title": "The bucket Schema",
"type": "string"
},
"region": {
"default": "us-west-1",
"examples": [
"us-west-1"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [],
"title": "The s3 Schema",
"type": "object"
},
"swift": {
"additionalProperties": false,
"default": {},
"examples": [
{
"authurl": "https://storage.myprovider.com/v3/auth",
"container": "containername",
"password": "password",
"username": "username"
}
],
"properties": {
"authurl": {
"default": "https://storage.myprovider.com/v3/auth",
"examples": [
"https://storage.myprovider.com/v3/auth"
],
"title": "The authurl Schema",
"type": "string"
},
"container": {
"default": "containername",
"examples": [
"containername"
],
"title": "The container Schema",
"type": "string"
},
"password": {
"default": "password",
"examples": [
"password"
],
"title": "The password Schema",
"type": "string"
},
"username": {
"default": "username",
"examples": [
"username"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [],
"title": "The swift Schema",
"type": "object"
},
"type": {
"default": "filesystem",
"examples": [
"filesystem"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The imageChartStorage Schema",
"type": "object"
},
"persistentVolumeClaim": {
"additionalProperties": false,
"default": {},
"examples": [
{
"chartmuseum": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"database": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"jobservice": {
"jobLog": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
},
"redis": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
},
"registry": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
},
"trivy": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
}
],
"properties": {
"chartmuseum": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The chartmuseum Schema",
"type": "object"
},
"database": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The database Schema",
"type": "object"
},
"jobservice": {
"additionalProperties": false,
"default": {},
"examples": [
{
"jobLog": {
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
}
],
"properties": {
"jobLog": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The jobLog Schema",
"type": "object"
}
},
"required": [],
"title": "The jobservice Schema",
"type": "object"
},
"redis": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "1Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The redis Schema",
"type": "object"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"trivy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"accessMode": "ReadWriteOnce",
"annotations": {},
"existingClaim": "",
"size": "5Gi",
"storageClass": "",
"subPath": ""
}
],
"properties": {
"accessMode": {
"default": "ReadWriteOnce",
"examples": [
"ReadWriteOnce"
],
"title": "The accessMode Schema",
"type": "string"
},
"annotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"existingClaim": {
"default": "",
"examples": [
""
],
"title": "The existingClaim Schema",
"type": "string"
},
"size": {
"default": "5Gi",
"examples": [
"5Gi"
],
"title": "The size Schema",
"type": "string"
},
"storageClass": {
"default": "",
"examples": [
""
],
"title": "The storageClass Schema",
"type": "string"
},
"subPath": {
"default": "",
"examples": [
""
],
"title": "The subPath Schema",
"type": "string"
}
},
"required": [],
"title": "The trivy Schema",
"type": "object"
}
},
"required": [],
"title": "The persistentVolumeClaim Schema",
"type": "object"
},
"resourcePolicy": {
"default": "keep",
"examples": [
"keep"
],
"title": "The resourcePolicy Schema",
"type": "string"
}
},
"required": [],
"title": "The persistence Schema",
"type": "object"
},
"portal": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:57eaec7d5bf9aa8cd7a63b84cb4542110a4fe444870be46a39e0e7f065e1cf55",
"repository": "harbor/harbor-portal"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"revisionHistoryLimit": 10,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:57eaec7d5bf9aa8cd7a63b84cb4542110a4fe444870be46a39e0e7f065e1cf55",
"repository": "harbor/harbor-portal"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:57eaec7d5bf9aa8cd7a63b84cb4542110a4fe444870be46a39e0e7f065e1cf55"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-portal",
"examples": [
"harbor/harbor-portal"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The portal Schema",
"type": "object"
},
"proxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"components": [
"core",
"jobservice",
"trivy"
],
"httpProxy": null,
"httpsProxy": null,
"noProxy": "127.0.0.1,localhost,.local,.internal"
}
],
"properties": {
"components": {
"default": [],
"examples": [
[
"core",
"jobservice",
"trivy"
]
],
"items": {
"examples": [
"core",
"jobservice",
"trivy"
],
"title": "A Schema",
"type": "string"
},
"title": "The components Schema",
"type": "array"
},
"httpProxy": {
"default": null,
"examples": [
null
],
"title": "The httpProxy Schema",
"type": "null"
},
"httpsProxy": {
"default": null,
"examples": [
null
],
"title": "The httpsProxy Schema",
"type": "null"
},
"noProxy": {
"default": "127.0.0.1,localhost,.local,.internal",
"examples": [
"127.0.0.1,localhost,.local,.internal"
],
"title": "The noProxy Schema",
"type": "string"
}
},
"required": [],
"title": "The proxy Schema",
"type": "object"
},
"pullSecretData": {
"default": "",
"examples": [
""
],
"title": "The pullSecretData Schema",
"type": "string"
},
"pullSecretName": {
"default": "",
"examples": [
""
],
"title": "The pullSecretName Schema",
"type": "string"
},
"redis": {
"additionalProperties": false,
"default": {},
"examples": [
{
"external": {
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"existingSecret": "",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
},
"internal": {
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:5fda938e140f7f098b776d520e5a8c4d9ce82b3785d9c6a465bcd533be88dfa9",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
},
"podAnnotations": {},
"type": "internal"
}
],
"properties": {
"external": {
"additionalProperties": false,
"default": {},
"examples": [
{
"addr": "192.168.0.2:6379",
"chartmuseumDatabaseIndex": "3",
"coreDatabaseIndex": "0",
"existingSecret": "",
"jobserviceDatabaseIndex": "1",
"password": "",
"registryDatabaseIndex": "2",
"sentinelMasterSet": "",
"trivyAdapterIndex": "5"
}
],
"properties": {
"addr": {
"default": "192.168.0.2:6379",
"examples": [
"192.168.0.2:6379"
],
"title": "The addr Schema",
"type": "string"
},
"chartmuseumDatabaseIndex": {
"default": "3",
"examples": [
"3"
],
"title": "The chartmuseumDatabaseIndex Schema",
"type": "string"
},
"coreDatabaseIndex": {
"default": "0",
"examples": [
"0"
],
"title": "The coreDatabaseIndex Schema",
"type": "string"
},
"existingSecret": {
"default": "",
"examples": [
""
],
"title": "The existingSecret Schema",
"type": "string"
},
"jobserviceDatabaseIndex": {
"default": "1",
"examples": [
"1"
],
"title": "The jobserviceDatabaseIndex Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
""
],
"title": "The password Schema",
"type": "string"
},
"registryDatabaseIndex": {
"default": "2",
"examples": [
"2"
],
"title": "The registryDatabaseIndex Schema",
"type": "string"
},
"sentinelMasterSet": {
"default": "",
"examples": [
""
],
"title": "The sentinelMasterSet Schema",
"type": "string"
},
"trivyAdapterIndex": {
"default": "5",
"examples": [
"5"
],
"title": "The trivyAdapterIndex Schema",
"type": "string"
}
},
"required": [],
"title": "The external Schema",
"type": "object"
},
"internal": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"image": {
"digest": "sha256:5fda938e140f7f098b776d520e5a8c4d9ce82b3785d9c6a465bcd533be88dfa9",
"repository": "harbor/harbor-redis"
},
"nodeSelector": {},
"priorityClassName": null,
"serviceAccountName": "",
"tolerations": []
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:5fda938e140f7f098b776d520e5a8c4d9ce82b3785d9c6a465bcd533be88dfa9",
"repository": "harbor/harbor-redis"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:5fda938e140f7f098b776d520e5a8c4d9ce82b3785d9c6a465bcd533be88dfa9"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-redis",
"examples": [
"harbor/harbor-redis"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [],
"title": "The internal Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"type": {
"default": "internal",
"examples": [
"internal"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The redis Schema",
"type": "object"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"controller": {
"image": {
"digest": "sha256:23552e406330014525f678a840d4b66dae145d28b29ab33dca17570b16329b24",
"repository": "harbor/harbor-registryctl"
}
},
"credentials": {
"existingSecret": "",
"password": "harbor_registry_password",
"username": "harbor_registry_user"
},
"middleware": {
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
},
"nodeSelector": {},
"podAnnotations": {},
"priorityClassName": null,
"registry": {
"image": {
"digest": "sha256:b120d0748fb9a8cd74bbfcd99a9520fab9543f3e770d1e76ac6be99e08dceb99",
"repository": "harbor/harbor-registry"
}
},
"relativeurls": true,
"replicas": 1,
"revisionHistoryLimit": 10,
"secret": "",
"serviceAccountName": "",
"tolerations": [],
"upload_purging": {
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"controller": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"digest": "sha256:23552e406330014525f678a840d4b66dae145d28b29ab33dca17570b16329b24",
"repository": "harbor/harbor-registryctl"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:23552e406330014525f678a840d4b66dae145d28b29ab33dca17570b16329b24",
"repository": "harbor/harbor-registryctl"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:23552e406330014525f678a840d4b66dae145d28b29ab33dca17570b16329b24"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-registryctl",
"examples": [
"harbor/harbor-registryctl"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
}
},
"required": [],
"title": "The controller Schema",
"type": "object"
},
"credentials": {
"additionalProperties": false,
"default": {},
"examples": [
{
"existingSecret": "",
"password": "harbor_registry_password",
"username": "harbor_registry_user"
}
],
"properties": {
"existingSecret": {
"default": "",
"examples": [
""
],
"title": "The existingSecret Schema",
"type": "string"
},
"password": {
"default": "harbor_registry_password",
"examples": [
"harbor_registry_password"
],
"title": "The password Schema",
"type": "string"
},
"username": {
"default": "harbor_registry_user",
"examples": [
"harbor_registry_user"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [],
"title": "The credentials Schema",
"type": "object"
},
"middleware": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cloudFront": {
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
},
"enabled": false,
"type": "cloudFront"
}
],
"properties": {
"cloudFront": {
"additionalProperties": false,
"default": {},
"examples": [
{
"baseurl": "example.cloudfront.net",
"duration": "3000s",
"ipfilteredby": "none",
"keypairid": "KEYPAIRID",
"privateKeySecret": "my-secret"
}
],
"properties": {
"baseurl": {
"default": "example.cloudfront.net",
"examples": [
"example.cloudfront.net"
],
"title": "The baseurl Schema",
"type": "string"
},
"duration": {
"default": "3000s",
"examples": [
"3000s"
],
"title": "The duration Schema",
"type": "string"
},
"ipfilteredby": {
"default": "none",
"examples": [
"none"
],
"title": "The ipfilteredby Schema",
"type": "string"
},
"keypairid": {
"default": "KEYPAIRID",
"examples": [
"KEYPAIRID"
],
"title": "The keypairid Schema",
"type": "string"
},
"privateKeySecret": {
"default": "my-secret",
"examples": [
"my-secret"
],
"title": "The privateKeySecret Schema",
"type": "string"
}
},
"required": [],
"title": "The cloudFront Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"type": {
"default": "cloudFront",
"examples": [
"cloudFront"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The middleware Schema",
"type": "object"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"registry": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"digest": "sha256:b120d0748fb9a8cd74bbfcd99a9520fab9543f3e770d1e76ac6be99e08dceb99",
"repository": "harbor/harbor-registry"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:b120d0748fb9a8cd74bbfcd99a9520fab9543f3e770d1e76ac6be99e08dceb99",
"repository": "harbor/harbor-registry"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:b120d0748fb9a8cd74bbfcd99a9520fab9543f3e770d1e76ac6be99e08dceb99"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-registry",
"examples": [
"harbor/harbor-registry"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"relativeurls": {
"default": true,
"examples": [
true
],
"title": "The relativeurls Schema",
"type": "boolean"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"revisionHistoryLimit": {
"default": 10,
"examples": [
10
],
"title": "The revisionHistoryLimit Schema",
"type": "integer"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"upload_purging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"age": "168h",
"dryrun": false,
"enabled": true,
"interval": "24h"
}
],
"properties": {
"age": {
"default": "168h",
"examples": [
"168h"
],
"title": "The age Schema",
"type": "string"
},
"dryrun": {
"default": false,
"examples": [
false
],
"title": "The dryrun Schema",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "24h",
"examples": [
"24h"
],
"title": "The interval Schema",
"type": "string"
}
},
"required": [],
"title": "The upload_purging Schema",
"type": "object"
}
},
"required": [],
"title": "The registry Schema",
"type": "object"
},
"secretKey": {
"default": "",
"examples": [
""
],
"title": "The secretKey Schema",
"type": "string"
},
"sourceRegistry": {
"default": "public.ecr.aws/eks-anywhere",
"examples": [
"public.ecr.aws/eks-anywhere"
],
"title": "The sourceRegistry Schema",
"type": "string"
},
"trace": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false,
"jaeger": {
"endpoint": "http://hostname:14268/api/traces"
},
"otel": {
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": 10,
"url_path": "/v1/traces"
},
"provider": "jaeger",
"sample_rate": 1
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"jaeger": {
"additionalProperties": false,
"default": {},
"examples": [
{
"endpoint": "http://hostname:14268/api/traces"
}
],
"properties": {
"endpoint": {
"default": "http://hostname:14268/api/traces",
"examples": [
"http://hostname:14268/api/traces"
],
"title": "The endpoint Schema",
"type": "string"
}
},
"required": [],
"title": "The jaeger Schema",
"type": "object"
},
"otel": {
"additionalProperties": false,
"default": {},
"examples": [
{
"compression": false,
"endpoint": "hostname:4318",
"insecure": true,
"timeout": 10,
"url_path": "/v1/traces"
}
],
"properties": {
"compression": {
"default": false,
"examples": [
false
],
"title": "The compression Schema",
"type": "boolean"
},
"endpoint": {
"default": "hostname:4318",
"examples": [
"hostname:4318"
],
"title": "The endpoint Schema",
"type": "string"
},
"insecure": {
"default": true,
"examples": [
true
],
"title": "The insecure Schema",
"type": "boolean"
},
"timeout": {
"default": 10,
"examples": [
10
],
"title": "The timeout Schema",
"type": "integer"
},
"url_path": {
"default": "/v1/traces",
"examples": [
"/v1/traces"
],
"title": "The url_path Schema",
"type": "string"
}
},
"required": [],
"title": "The otel Schema",
"type": "object"
},
"provider": {
"default": "jaeger",
"examples": [
"jaeger"
],
"title": "The provider Schema",
"type": "string"
},
"sample_rate": {
"default": 1,
"examples": [
1
],
"title": "The sample_rate Schema",
"type": "integer"
}
},
"required": [],
"title": "The trace Schema",
"type": "object"
},
"trivy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"affinity": {},
"automountServiceAccountToken": false,
"debugMode": false,
"enabled": true,
"gitHubToken": "",
"ignoreUnfixed": false,
"image": {
"digest": "sha256:84d2a9de23541ca792e2d0e54e01d4ef4ad1205ea5aa942e342cd9bab1c98f2d",
"repository": "harbor/harbor-trivy"
},
"insecure": false,
"nodeSelector": {},
"offlineScan": false,
"podAnnotations": {},
"priorityClassName": null,
"replicas": 1,
"resources": {
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
},
"securityCheck": "vuln",
"serviceAccountName": "",
"severity": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"skipUpdate": false,
"timeout": "5m0s",
"tolerations": [],
"vulnType": "os,library"
}
],
"properties": {
"affinity": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": false,
"examples": [
false
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"debugMode": {
"default": false,
"examples": [
false
],
"title": "The debugMode Schema",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"gitHubToken": {
"default": "",
"examples": [
""
],
"title": "The gitHubToken Schema",
"type": "string"
},
"ignoreUnfixed": {
"default": false,
"examples": [
false
],
"title": "The ignoreUnfixed Schema",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"digest": "sha256:84d2a9de23541ca792e2d0e54e01d4ef4ad1205ea5aa942e342cd9bab1c98f2d",
"repository": "harbor/harbor-trivy"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:84d2a9de23541ca792e2d0e54e01d4ef4ad1205ea5aa942e342cd9bab1c98f2d"
],
"title": "The digest Schema",
"type": "string"
},
"repository": {
"default": "harbor/harbor-trivy",
"examples": [
"harbor/harbor-trivy"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"insecure": {
"default": false,
"examples": [
false
],
"title": "The insecure Schema",
"type": "boolean"
},
"nodeSelector": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"offlineScan": {
"default": false,
"examples": [
false
],
"title": "The offlineScan Schema",
"type": "boolean"
},
"podAnnotations": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"priorityClassName": {
"default": null,
"examples": [
null
],
"title": "The priorityClassName Schema",
"type": "null"
},
"replicas": {
"default": 1,
"examples": [
1
],
"title": "The replicas Schema",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": 1,
"memory": "1Gi"
},
"requests": {
"cpu": "200m",
"memory": "512Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": 1,
"memory": "1Gi"
}
],
"properties": {
"cpu": {
"default": 1,
"examples": [
1
],
"title": "The cpu Schema",
"type": "integer"
},
"memory": {
"default": "1Gi",
"examples": [
"1Gi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "200m",
"memory": "512Mi"
}
],
"properties": {
"cpu": {
"default": "200m",
"examples": [
"200m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "512Mi",
"examples": [
"512Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The requests Schema",
"type": "object"
}
},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityCheck": {
"default": "vuln",
"examples": [
"vuln"
],
"title": "The securityCheck Schema",
"type": "string"
},
"serviceAccountName": {
"default": "",
"examples": [
""
],
"title": "The serviceAccountName Schema",
"type": "string"
},
"severity": {
"default": "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL",
"examples": [
"UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL"
],
"title": "The severity Schema",
"type": "string"
},
"skipUpdate": {
"default": false,
"examples": [
false
],
"title": "The skipUpdate Schema",
"type": "boolean"
},
"timeout": {
"default": "5m0s",
"examples": [
"5m0s"
],
"title": "The timeout Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"vulnType": {
"default": "os,library",
"examples": [
"os,library"
],
"title": "The vulnType Schema",
"type": "string"
}
},
"required": [],
"title": "The trivy Schema",
"type": "object"
},
"updateStrategy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"type": "Recreate"
}
],
"properties": {
"type": {
"default": "Recreate",
"examples": [
"Recreate"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"required": [
"secretKey"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 107d9330c446cf66ba25ee80128afdd83390abed | 2023-02-24T15:08:20 | projects/kubernetes/autoscaler/1-26/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"additionalLabels": {},
"affinity": {},
"autoDiscovery": {
"clusterName": "my-cluster",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
},
"autoscalingGroups": [],
"autoscalingGroupsnamePrefix": [],
"awsAccessKeyID": "",
"awsRegion": "us-east-1",
"awsSecretAccessKey": "",
"azureClientID": "",
"azureClientSecret": "",
"azureClusterName": "",
"azureNodeResourceGroup": "",
"azureResourceGroup": "",
"azureSubscriptionID": "",
"azureTenantID": "",
"azureUseManagedIdentityExtension": false,
"azureVMType": "AKS",
"cloudConfigPath": "",
"cloudProvider": "clusterapi",
"clusterAPICloudConfigPath": "/etc/kubernetes/mgmt-kubeconfig",
"clusterAPIConfigMapsNamespace": "",
"clusterAPIKubeconfigSecret": "",
"clusterAPIMode": "incluster-incluster",
"clusterAPIWorkloadKubeconfigPath": "/etc/kubernetes/value",
"containerSecurityContext": {},
"deployment": {
"annotations": {}
},
"dnsPolicy": "ClusterFirst",
"envFromConfigMap": "",
"envFromSecret": "",
"expanderPriorities": {},
"extraArgs": {
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
},
"extraEnv": {},
"extraEnvConfigMaps": {},
"extraEnvSecrets": {},
"extraVolumeMounts": [],
"extraVolumeSecrets": {},
"extraVolumes": [],
"fullnameOverride": "",
"image": {
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
},
"imagePullSecrets": [],
"kubeTargetVersionOverride": "",
"magnumCABundlePath": "/etc/kubernetes/ca-bundle.crt",
"magnumClusterName": "",
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"maxUnavailable": 1
},
"podLabels": {},
"priorityClassName": "system-cluster-critical",
"priorityConfigMapAnnotations": {},
"prometheusRule": {
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
},
"rbac": {
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
},
"replicaCount": 1,
"resources": {},
"securityContext": {},
"service": {
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
},
"sourceRegistry": "public.ecr.aws",
"tolerations": [],
"topologySpreadConstraints": [],
"updateStrategy": {}
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"autoDiscovery": {
"default": {},
"examples": [
{
"clusterName": "my-cluster-name",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
}
],
"properties": {
"clusterName": {
"default": "",
"examples": [
"my-cluster-name"
],
"title": "The clusterName Schema",
"type": "string"
},
"labels": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The labels Schema",
"type": "array"
},
"roles": {
"default": [],
"examples": [
[
"worker"
]
],
"items": {
"default": "",
"examples": [
"worker"
],
"title": "A Schema",
"type": "string"
},
"title": "The roles Schema",
"type": "array"
},
"tags": {
"default": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"examples": [
[
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
],
"items": {
"examples": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"title": "A Schema",
"type": "string"
},
"title": "The tags Schema",
"type": "array"
}
},
"required": [],
"title": "The autoDiscovery Schema",
"type": "object"
},
"autoscalingGroups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroups Schema",
"type": "array"
},
"autoscalingGroupsnamePrefix": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroupsnamePrefix Schema",
"type": "array"
},
"awsAccessKeyID": {
"default": "",
"examples": [
""
],
"title": "The awsAccessKeyID Schema",
"type": "string"
},
"awsRegion": {
"default": "",
"examples": [
"us-east-1"
],
"title": "The awsRegion Schema",
"type": "string"
},
"awsSecretAccessKey": {
"default": "",
"examples": [
""
],
"title": "The awsSecretAccessKey Schema",
"type": "string"
},
"azureClientID": {
"default": "",
"examples": [
""
],
"title": "The azureClientID Schema",
"type": "string"
},
"azureClientSecret": {
"default": "",
"examples": [
""
],
"title": "The azureClientSecret Schema",
"type": "string"
},
"azureClusterName": {
"default": "",
"examples": [
""
],
"title": "The azureClusterName Schema",
"type": "string"
},
"azureNodeResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureNodeResourceGroup Schema",
"type": "string"
},
"azureResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureResourceGroup Schema",
"type": "string"
},
"azureSubscriptionID": {
"default": "",
"examples": [
""
],
"title": "The azureSubscriptionID Schema",
"type": "string"
},
"azureTenantID": {
"default": "",
"examples": [
""
],
"title": "The azureTenantID Schema",
"type": "string"
},
"azureUseManagedIdentityExtension": {
"default": false,
"examples": [
false
],
"title": "The azureUseManagedIdentityExtension Schema",
"type": "boolean"
},
"azureVMType": {
"default": "",
"examples": [
"AKS"
],
"title": "The azureVMType Schema",
"type": "string"
},
"cloudConfigPath": {
"default": "",
"examples": [
""
],
"title": "The cloudConfigPath Schema",
"type": "string"
},
"cloudProvider": {
"default": "",
"examples": [
"clusterapi"
],
"title": "The cloudProvider Schema",
"type": "string"
},
"clusterAPICloudConfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/mgmt-kubeconfig"
],
"title": "The clusterAPICloudConfigPath Schema",
"type": "string"
},
"clusterAPIConfigMapsNamespace": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIConfigMapsNamespace Schema",
"type": "string"
},
"clusterAPIKubeconfigSecret": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIKubeconfigSecret Schema",
"type": "string"
},
"clusterAPIMode": {
"default": "",
"examples": [
"incluster-incluster"
],
"title": "The clusterAPIMode Schema",
"type": "string"
},
"clusterAPIWorkloadKubeconfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/value"
],
"title": "The clusterAPIWorkloadKubeconfigPath Schema",
"type": "string"
},
"containerSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The containerSecurityContext Schema",
"type": "object"
},
"deployment": {
"default": {},
"examples": [
{
"annotations": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
}
},
"required": [
"annotations"
],
"title": "The deployment Schema",
"type": "object"
},
"dnsPolicy": {
"default": "",
"examples": [
"ClusterFirst"
],
"title": "The dnsPolicy Schema",
"type": "string"
},
"envFromConfigMap": {
"default": "",
"examples": [
""
],
"title": "The envFromConfigMap Schema",
"type": "string"
},
"envFromSecret": {
"default": "",
"examples": [
""
],
"title": "The envFromSecret Schema",
"type": "string"
},
"expanderPriorities": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The expanderPriorities Schema",
"type": "object"
},
"extraArgs": {
"default": {},
"examples": [
{
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
}
],
"properties": {
"logtostderr": {
"default": true,
"examples": [
true
],
"title": "The logtostderr Schema",
"type": "boolean"
},
"stderrthreshold": {
"default": "info",
"examples": [
"info"
],
"title": "The stderrthreshold Schema",
"type": "string"
},
"v": {
"default": 4,
"examples": [
4
],
"title": "The v Schema",
"type": "integer"
}
},
"required": [],
"title": "The extraArgs Schema",
"type": "object"
},
"extraEnv": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnv Schema",
"type": "object"
},
"extraEnvConfigMaps": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvConfigMaps Schema",
"type": "object"
},
"extraEnvSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvSecrets Schema",
"type": "object"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumeSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraVolumeSecrets Schema",
"type": "object"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "kubernetes/autoscaler",
"examples": [
"kubernetes/autoscaler"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeTargetVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeTargetVersionOverride Schema",
"type": "string"
},
"magnumCABundlePath": {
"default": "",
"examples": [
"/etc/kubernetes/ca-bundle.crt"
],
"title": "The magnumCABundlePath Schema",
"type": "string"
},
"magnumClusterName": {
"default": "",
"examples": [
""
],
"title": "The magnumClusterName Schema",
"type": "string"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"maxUnavailable": 1
}
],
"properties": {
"maxUnavailable": {
"default": 1,
"examples": [
1
],
"title": "The maxUnavailable Schema",
"type": "integer"
}
},
"required": [
"maxUnavailable"
],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"priorityConfigMapAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The priorityConfigMapAnnotations Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"rules": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The rules Schema",
"type": "array"
}
},
"required": [],
"title": "The prometheusRule Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
}
],
"properties": {
"clusterScoped": {
"default": true,
"examples": [
true
],
"title": "The clusterScoped Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"externalIPs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The externalIPs Schema",
"type": "array"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"loadBalancerIP": {
"default": "",
"examples": [
""
],
"title": "The loadBalancerIP Schema",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The loadBalancerSourceRanges Schema",
"type": "array"
},
"portName": {
"default": "http",
"examples": [
"http"
],
"title": "The portName Schema",
"type": "string"
},
"servicePort": {
"default": 8085,
"examples": [
8085
],
"title": "The servicePort Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The metricRelabelings Schema",
"type": "object"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"selector": {
"default": {},
"examples": [
{
"release": "prometheus-operator"
}
],
"properties": {
"release": {
"default": "prometheus-operator",
"examples": [
"prometheus-operator"
],
"title": "The release Schema",
"type": "string"
}
},
"required": [],
"title": "The selector Schema",
"type": "object"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | 7ac6ce85afa1d33e1a1a39a7efacb6f52445ba7c | 2023-04-25T21:07:27 | projects/kubernetes/autoscaler/1-27/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"additionalLabels": {},
"affinity": {},
"autoDiscovery": {
"clusterName": "my-cluster",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
},
"autoscalingGroups": [],
"autoscalingGroupsnamePrefix": [],
"awsAccessKeyID": "",
"awsRegion": "us-east-1",
"awsSecretAccessKey": "",
"azureClientID": "",
"azureClientSecret": "",
"azureClusterName": "",
"azureNodeResourceGroup": "",
"azureResourceGroup": "",
"azureSubscriptionID": "",
"azureTenantID": "",
"azureUseManagedIdentityExtension": false,
"azureVMType": "AKS",
"cloudConfigPath": "",
"cloudProvider": "clusterapi",
"clusterAPICloudConfigPath": "/etc/kubernetes/mgmt-kubeconfig",
"clusterAPIConfigMapsNamespace": "",
"clusterAPIKubeconfigSecret": "",
"clusterAPIMode": "incluster-incluster",
"clusterAPIWorkloadKubeconfigPath": "/etc/kubernetes/value",
"containerSecurityContext": {},
"deployment": {
"annotations": {}
},
"dnsPolicy": "ClusterFirst",
"envFromConfigMap": "",
"envFromSecret": "",
"expanderPriorities": {},
"extraArgs": {
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
},
"extraEnv": {},
"extraEnvConfigMaps": {},
"extraEnvSecrets": {},
"extraVolumeMounts": [],
"extraVolumeSecrets": {},
"extraVolumes": [],
"fullnameOverride": "",
"image": {
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
},
"imagePullSecrets": [],
"kubeTargetVersionOverride": "",
"magnumCABundlePath": "/etc/kubernetes/ca-bundle.crt",
"magnumClusterName": "",
"nameOverride": "",
"nodeSelector": {},
"podAnnotations": {},
"podDisruptionBudget": {
"maxUnavailable": 1
},
"podLabels": {},
"priorityClassName": "system-cluster-critical",
"priorityConfigMapAnnotations": {},
"prometheusRule": {
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
},
"rbac": {
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
},
"replicaCount": 1,
"resources": {},
"securityContext": {},
"service": {
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
},
"sourceRegistry": "public.ecr.aws",
"tolerations": [],
"topologySpreadConstraints": [],
"updateStrategy": {}
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"autoDiscovery": {
"default": {},
"examples": [
{
"clusterName": "my-cluster-name",
"labels": [],
"roles": [
"worker"
],
"tags": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
}
],
"properties": {
"clusterName": {
"default": "",
"examples": [
"my-cluster-name"
],
"title": "The clusterName Schema",
"type": "string"
},
"labels": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The labels Schema",
"type": "array"
},
"roles": {
"default": [],
"examples": [
[
"worker"
]
],
"items": {
"default": "",
"examples": [
"worker"
],
"title": "A Schema",
"type": "string"
},
"title": "The roles Schema",
"type": "array"
},
"tags": {
"default": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"examples": [
[
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
]
],
"items": {
"examples": [
"k8s.io/cluster-autoscaler/enabled",
"k8s.io/cluster-autoscaler/{{ .Values.autoDiscovery.clusterName }}"
],
"title": "A Schema",
"type": "string"
},
"title": "The tags Schema",
"type": "array"
}
},
"required": [],
"title": "The autoDiscovery Schema",
"type": "object"
},
"autoscalingGroups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroups Schema",
"type": "array"
},
"autoscalingGroupsnamePrefix": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The autoscalingGroupsnamePrefix Schema",
"type": "array"
},
"awsAccessKeyID": {
"default": "",
"examples": [
""
],
"title": "The awsAccessKeyID Schema",
"type": "string"
},
"awsRegion": {
"default": "",
"examples": [
"us-east-1"
],
"title": "The awsRegion Schema",
"type": "string"
},
"awsSecretAccessKey": {
"default": "",
"examples": [
""
],
"title": "The awsSecretAccessKey Schema",
"type": "string"
},
"azureClientID": {
"default": "",
"examples": [
""
],
"title": "The azureClientID Schema",
"type": "string"
},
"azureClientSecret": {
"default": "",
"examples": [
""
],
"title": "The azureClientSecret Schema",
"type": "string"
},
"azureClusterName": {
"default": "",
"examples": [
""
],
"title": "The azureClusterName Schema",
"type": "string"
},
"azureNodeResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureNodeResourceGroup Schema",
"type": "string"
},
"azureResourceGroup": {
"default": "",
"examples": [
""
],
"title": "The azureResourceGroup Schema",
"type": "string"
},
"azureSubscriptionID": {
"default": "",
"examples": [
""
],
"title": "The azureSubscriptionID Schema",
"type": "string"
},
"azureTenantID": {
"default": "",
"examples": [
""
],
"title": "The azureTenantID Schema",
"type": "string"
},
"azureUseManagedIdentityExtension": {
"default": false,
"examples": [
false
],
"title": "The azureUseManagedIdentityExtension Schema",
"type": "boolean"
},
"azureVMType": {
"default": "",
"examples": [
"AKS"
],
"title": "The azureVMType Schema",
"type": "string"
},
"cloudConfigPath": {
"default": "",
"examples": [
""
],
"title": "The cloudConfigPath Schema",
"type": "string"
},
"cloudProvider": {
"default": "",
"examples": [
"clusterapi"
],
"title": "The cloudProvider Schema",
"type": "string"
},
"clusterAPICloudConfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/mgmt-kubeconfig"
],
"title": "The clusterAPICloudConfigPath Schema",
"type": "string"
},
"clusterAPIConfigMapsNamespace": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIConfigMapsNamespace Schema",
"type": "string"
},
"clusterAPIKubeconfigSecret": {
"default": "",
"examples": [
""
],
"title": "The clusterAPIKubeconfigSecret Schema",
"type": "string"
},
"clusterAPIMode": {
"default": "",
"examples": [
"incluster-incluster"
],
"title": "The clusterAPIMode Schema",
"type": "string"
},
"clusterAPIWorkloadKubeconfigPath": {
"default": "",
"examples": [
"/etc/kubernetes/value"
],
"title": "The clusterAPIWorkloadKubeconfigPath Schema",
"type": "string"
},
"containerSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The containerSecurityContext Schema",
"type": "object"
},
"deployment": {
"default": {},
"examples": [
{
"annotations": {}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
}
},
"required": [
"annotations"
],
"title": "The deployment Schema",
"type": "object"
},
"dnsPolicy": {
"default": "",
"examples": [
"ClusterFirst"
],
"title": "The dnsPolicy Schema",
"type": "string"
},
"envFromConfigMap": {
"default": "",
"examples": [
""
],
"title": "The envFromConfigMap Schema",
"type": "string"
},
"envFromSecret": {
"default": "",
"examples": [
""
],
"title": "The envFromSecret Schema",
"type": "string"
},
"expanderPriorities": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The expanderPriorities Schema",
"type": "object"
},
"extraArgs": {
"default": {},
"examples": [
{
"logtostderr": true,
"stderrthreshold": "info",
"v": 4
}
],
"properties": {
"logtostderr": {
"default": true,
"examples": [
true
],
"title": "The logtostderr Schema",
"type": "boolean"
},
"stderrthreshold": {
"default": "info",
"examples": [
"info"
],
"title": "The stderrthreshold Schema",
"type": "string"
},
"v": {
"default": 4,
"examples": [
4
],
"title": "The v Schema",
"type": "integer"
}
},
"required": [],
"title": "The extraArgs Schema",
"type": "object"
},
"extraEnv": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnv Schema",
"type": "object"
},
"extraEnvConfigMaps": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvConfigMaps Schema",
"type": "object"
},
"extraEnvSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraEnvSecrets Schema",
"type": "object"
},
"extraVolumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumeMounts Schema",
"type": "array"
},
"extraVolumeSecrets": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraVolumeSecrets Schema",
"type": "object"
},
"extraVolumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraVolumes Schema",
"type": "array"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5",
"pullPolicy": "IfNotPresent",
"repository": "kubernetes/autoscaler"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:7264e721263a683313271d874fe80984fdbeb5b60af5e0a6c9ab2f4e8bf802c5"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "kubernetes/autoscaler",
"examples": [
"kubernetes/autoscaler"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeTargetVersionOverride": {
"default": "",
"examples": [
""
],
"title": "The kubeTargetVersionOverride Schema",
"type": "string"
},
"magnumCABundlePath": {
"default": "",
"examples": [
"/etc/kubernetes/ca-bundle.crt"
],
"title": "The magnumCABundlePath Schema",
"type": "string"
},
"magnumClusterName": {
"default": "",
"examples": [
""
],
"title": "The magnumClusterName Schema",
"type": "string"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"maxUnavailable": 1
}
],
"properties": {
"maxUnavailable": {
"default": 1,
"examples": [
1
],
"title": "The maxUnavailable Schema",
"type": "integer"
}
},
"required": [
"maxUnavailable"
],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
"system-cluster-critical"
],
"title": "The priorityClassName Schema",
"type": "string"
},
"priorityConfigMapAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The priorityConfigMapAnnotations Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"additionalLabels": {},
"enabled": false,
"interval": "10s",
"namespace": "monitoring",
"rules": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"rules": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The rules Schema",
"type": "array"
}
},
"required": [],
"title": "The prometheusRule Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"clusterScoped": true,
"create": true,
"pspEnabled": false,
"serviceAccount": {
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
}
],
"properties": {
"clusterScoped": {
"default": true,
"examples": [
true
],
"title": "The clusterScoped Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"pspEnabled": {
"default": false,
"examples": [
false
],
"title": "The pspEnabled Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"automountServiceAccountToken": true,
"create": true,
"name": ""
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"examples": [
true
],
"title": "The automountServiceAccountToken Schema",
"type": "boolean"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"externalIPs": [],
"labels": {},
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"portName": "http",
"servicePort": 8085,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"externalIPs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The externalIPs Schema",
"type": "array"
},
"labels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The labels Schema",
"type": "object"
},
"loadBalancerIP": {
"default": "",
"examples": [
""
],
"title": "The loadBalancerIP Schema",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The loadBalancerSourceRanges Schema",
"type": "array"
},
"portName": {
"default": "http",
"examples": [
"http"
],
"title": "The portName Schema",
"type": "string"
},
"servicePort": {
"default": 8085,
"examples": [
8085
],
"title": "The servicePort Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"interval": "10s",
"metricRelabelings": {},
"namespace": "monitoring",
"path": "/metrics",
"selector": {
"release": "prometheus-operator"
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"interval": {
"default": "10s",
"examples": [
"10s"
],
"title": "The interval Schema",
"type": "string"
},
"metricRelabelings": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The metricRelabelings Schema",
"type": "object"
},
"namespace": {
"default": "monitoring",
"examples": [
"monitoring"
],
"title": "The namespace Schema",
"type": "string"
},
"path": {
"default": "/metrics",
"examples": [
"/metrics"
],
"title": "The path Schema",
"type": "string"
},
"selector": {
"default": {},
"examples": [
{
"release": "prometheus-operator"
}
],
"properties": {
"release": {
"default": "prometheus-operator",
"examples": [
"prometheus-operator"
],
"title": "The release Schema",
"type": "string"
}
},
"required": [],
"title": "The selector Schema",
"type": "object"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
},
"sourceRegistry": {
"description": "Override source registry of the helm chart.",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
},
"updateStrategy": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The updateStrategy Schema",
"type": "object"
}
},
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
aws/eks-anywhere-build-tooling | a79c07e994ba9dd67429d8117e065da6893554fa | 2022-07-28T17:31:22 | projects/emissary-ingress/emissary/helm/schema.json | 48 | 2024-05-28T05:39:32.291322Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"adminService": {
"annotations": {},
"create": true,
"loadBalancerIP": null,
"loadBalancerSourceRanges": null,
"nodePort": null,
"port": 8877,
"snapshotPort": 8005,
"type": "ClusterIP"
},
"affinity": {},
"barePod": false,
"deploymentStrategy": {
"type": "RollingUpdate"
},
"dnsPolicy": "ClusterFirst",
"docker": {},
"env": {},
"hostNetwork": false,
"image": {
"digest": "sha256:735898bc7a555ce0d842cf28eefaa9824eb5f28396e9eb229ae05c0d601c4e3e",
"pullPolicy": "IfNotPresent",
"repository": "emissary-ingress/emissary",
"tag": null
},
"imagePullSecrets": [],
"ingressClassResource": {
"controllerValue": "getambassador.io/ingress-controller",
"default": false,
"enabled": true,
"name": "ambassador"
},
"livenessProbe": {
"failureThreshold": 3,
"initialDelaySeconds": 30,
"periodSeconds": 3
},
"nodeSelector": {},
"podDisruptionBudget": {},
"rbac": {
"create": true,
"nameOverride": null,
"podSecurityPolicies": []
},
"readinessProbe": {
"failureThreshold": 3,
"initialDelaySeconds": 30,
"periodSeconds": 3
},
"replicaCount": 2,
"resources": {
"limits": {
"cpu": "1000m",
"memory": "600Mi"
},
"requests": {
"cpu": "200m",
"memory": "300Mi"
}
},
"service": {
"annotations": {},
"externalIPs": [],
"externalTrafficPolicy": null,
"nameOverride": null,
"ports": [
{
"name": "http",
"port": 80,
"targetPort": 8080
},
{
"name": "https",
"port": 443,
"targetPort": 8443
}
],
"portsRaw": "",
"sessionAffinity": null,
"sessionAffinityConfig": null,
"type": "LoadBalancer"
},
"serviceAccount": {
"create": true,
"extra": "",
"name": null
},
"sourceRegistry": "public.ecr.aws/eks-anywhere",
"tolerations": [],
"volumeMounts": [],
"volumes": []
}
],
"properties": {
"adminService": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"loadBalancerIP": null,
"loadBalancerSourceRanges": null,
"nodePort": null,
"port": 8877,
"snapshotPort": 8005,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"loadBalancerIP": {
"default": null,
"examples": [
null
],
"title": "The loadBalancerIP Schema",
"type": "null"
},
"loadBalancerSourceRanges": {
"default": null,
"examples": [
null
],
"title": "The loadBalancerSourceRanges Schema",
"type": "null"
},
"nodePort": {
"default": null,
"examples": [
null
],
"title": "The nodePort Schema",
"type": "null"
},
"port": {
"default": 8877,
"examples": [
8877
],
"title": "The port Schema",
"type": "integer"
},
"snapshotPort": {
"default": 8005,
"examples": [
8005
],
"title": "The snapshotPort Schema",
"type": "integer"
},
"type": {
"default": "ClusterIP",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"create",
"type",
"port"
],
"title": "The adminService Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"daemonSet": {
"default": false,
"examples": [
false
],
"title": "The daemonSet Schema",
"type": "boolean"
},
"deploymentStrategy": {
"default": {},
"examples": [
{
"type": "RollingUpdate"
}
],
"properties": {
"type": {
"default": "RollingUpdate",
"examples": [
"RollingUpdate"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type"
],
"title": "The deploymentStrategy Schema",
"type": "object"
},
"dnsPolicy": {
"default": "ClusterFirst",
"examples": [
"ClusterFirst"
],
"title": "The dnsPolicy Schema",
"type": "string"
},
"docker": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The docker Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The env Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"digest": "sha256:735898bc7a555ce0d842cf28eefaa9824eb5f28396e9eb229ae05c0d601c4e3e",
"pullPolicy": "IfNotPresent",
"repository": "emissary-ingress/emissary",
"tag": null
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:735898bc7a555ce0d842cf28eefaa9824eb5f28396e9eb229ae05c0d601c4e3e"
],
"title": "The digest Schema",
"type": "string"
},
"pullPolicy": {
"default": "IfNotPresent",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "emissary-ingress/emissary",
"examples": [
"emissary-ingress/emissary"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": null,
"examples": [
null
],
"title": "The tag Schema",
"type": "null"
}
},
"required": [
"repository",
"digest"
],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"ingressClassResource": {
"default": {},
"examples": [
{
"controllerValue": "getambassador.io/ingress-controller",
"default": false,
"enabled": true,
"name": "ambassador"
}
],
"properties": {
"controllerValue": {
"default": "getambassador.io/ingress-controller",
"examples": [
"getambassador.io/ingress-controller"
],
"title": "The controllerValue Schema",
"type": "string"
},
"default": {
"default": false,
"examples": [
false
],
"title": "The default Schema",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"name": {
"default": "ambassador",
"examples": [
"ambassador"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"enabled",
"name"
],
"title": "The ingressClassResource Schema",
"type": "object"
},
"livenessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"initialDelaySeconds": 30,
"periodSeconds": 3
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"initialDelaySeconds": {
"default": 30,
"examples": [
30
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 3,
"examples": [
3
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [
"initialDelaySeconds",
"periodSeconds",
"failureThreshold"
],
"title": "The livenessProbe Schema",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{}
],
"properties": {},
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"create": true,
"nameOverride": null,
"podSecurityPolicies": []
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"nameOverride": {
"default": null,
"examples": [
null
],
"title": "The nameOverride Schema",
"type": "null"
},
"podSecurityPolicies": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The podSecurityPolicies Schema",
"type": "array"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"readinessProbe": {
"default": {},
"examples": [
{
"failureThreshold": 3,
"initialDelaySeconds": 30,
"periodSeconds": 3
}
],
"properties": {
"failureThreshold": {
"default": 3,
"examples": [
3
],
"title": "The failureThreshold Schema",
"type": "integer"
},
"initialDelaySeconds": {
"default": 30,
"examples": [
30
],
"title": "The initialDelaySeconds Schema",
"type": "integer"
},
"periodSeconds": {
"default": 3,
"examples": [
3
],
"title": "The periodSeconds Schema",
"type": "integer"
}
},
"required": [
"initialDelaySeconds",
"periodSeconds",
"failureThreshold"
],
"title": "The readinessProbe Schema",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "The replicaCount Schema",
"type": "integer"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "1000m",
"memory": "600Mi"
},
"requests": {
"cpu": "200m",
"memory": "300Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "1000m",
"memory": "600Mi"
}
],
"properties": {
"cpu": {
"default": "1000m",
"examples": [
"1000m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "600Mi",
"examples": [
"600Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "200m",
"memory": "300Mi"
}
],
"properties": {
"cpu": {
"default": "200m",
"examples": [
"200m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "300Mi",
"examples": [
"300Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"annotations": {},
"externalIPs": [],
"externalTrafficPolicy": null,
"nameOverride": null,
"ports": [
{
"name": "http",
"port": 80,
"targetPort": 8080
},
{
"name": "https",
"port": 443,
"targetPort": 8443
}
],
"portsRaw": "",
"sessionAffinity": null,
"sessionAffinityConfig": null,
"type": "LoadBalancer"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"externalIPs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The externalIPs Schema",
"type": "array"
},
"externalTrafficPolicy": {
"default": null,
"examples": [
null
],
"title": "The externalTrafficPolicy Schema",
"type": "null"
},
"nameOverride": {
"default": null,
"examples": [
null
],
"title": "The nameOverride Schema",
"type": "null"
},
"ports": {
"default": [],
"examples": [
[
{
"name": "http",
"port": 80,
"targetPort": 8080
},
{
"name": "https",
"port": 443,
"targetPort": 8443
}
]
],
"items": {
"examples": [
{
"name": "http",
"port": 80,
"targetPort": 8080
},
{
"name": "https",
"port": 443,
"targetPort": 8443
}
],
"properties": {
"name": {
"examples": [
"http",
"https"
],
"title": "The name Schema",
"type": "string"
},
"port": {
"examples": [
80,
443
],
"title": "The port Schema",
"type": "integer"
},
"targetPort": {
"examples": [
8080,
8443
],
"title": "The targetPort Schema",
"type": "integer"
}
},
"required": [
"name",
"port",
"targetPort"
],
"title": "A Schema",
"type": "object"
},
"title": "The ports Schema",
"type": "array"
},
"portsRaw": {
"default": "",
"examples": [
""
],
"title": "The portsRaw Schema",
"type": "string"
},
"sessionAffinity": {
"default": null,
"examples": [
null
],
"title": "The sessionAffinity Schema",
"type": "null"
},
"sessionAffinityConfig": {
"default": null,
"examples": [
null
],
"title": "The sessionAffinityConfig Schema",
"type": "null"
},
"type": {
"default": "",
"examples": [
"LoadBalancer"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"ports"
],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"create": true,
"extra": "",
"name": null
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"extra": {
"default": "",
"examples": [
""
],
"title": "The extra Schema",
"type": "string"
},
"name": {
"default": null,
"examples": [
null
],
"title": "The name Schema",
"type": "null"
}
},
"required": [
"create"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"sourceRegistry": {
"default": "public.ecr.aws/eks-anywhere",
"examples": [
"public.ecr.aws/eks-anywhere"
],
"title": "The sourceRegistry Schema",
"type": "string"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"volumeMounts": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The volumeMounts Schema",
"type": "array"
},
"volumes": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The volumes Schema",
"type": "array"
}
},
"required": [
"sourceRegistry",
"image",
"service"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.