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
invopop/jsonschema
e803ab25037d05b814b4b8ae313762cc1c75be79
2020-01-29T02:05:56
fixtures/allow_additional_props.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": true, "properties": { "Baz": { "foo": "bar", "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "TestFlag", "age", "email", "Baz", "color" ], "type": "object" } } }
MIT
en
invopop/jsonschema
fbf400c964771617882771526b353e61e2cda9df
2022-08-04T10:32:40
fixtures/go_comments.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "NamedPets": { "additionalProperties": { "$ref": "#/$defs/Pet" }, "description": "NamedPets is a map of animal names to pets.", "type": "object" }, "Pet": { "additionalProperties": false, "description": "Pet defines the user's fury friend.", "properties": { "name": { "description": "Name of the animal.", "title": "Name", "type": "string" } }, "required": [ "name" ], "type": "object" }, "Pets": { "description": "Pets is a collection of Pet objects.", "items": { "$ref": "#/$defs/Pet" }, "type": "array" }, "Plant": { "additionalProperties": false, "description": "Plant represents the plants the user might have and serves as a test of structs inside a `type` set.", "properties": { "variant": { "title": "Variant", "type": "string" } }, "required": [ "variant" ], "type": "object" }, "User": { "additionalProperties": false, "description": "User is used as a base to provide tests for comments.", "properties": { "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "id": { "description": "Unique sequential identifier.", "type": "integer" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "named_pets": { "$ref": "#/$defs/NamedPets", "description": "Set of animal names to pets" }, "pets": { "$ref": "#/$defs/Pets", "description": "An array of pets the user cares for." }, "plants": { "description": "Set of plants that the user likes", "items": { "$ref": "#/$defs/Plant" }, "title": "Plants", "type": "array" }, "tags": { "type": "object" } }, "required": [ "id", "name", "pets", "named_pets", "plants" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/examples/user", "$ref": "#/$defs/User", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
d65fe469b0489087e7f77154846f6fe5e31a0d0b
2020-02-10T11:53:47
fixtures/required_from_jsontags.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": false, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "Baz": { "foo": "bar", "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "SomeUntaggedBaseProperty", "id", "name", "photo" ], "type": "object" } } }
MIT
en
invopop/jsonschema
fd8d96416671e33ef79358139312e88557a8aaab
2019-05-30T23:57:21
fixtures/defaults_expanded_toplevel.json
457
2024-05-27T06:45:28.205821Z
{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "GrandfatherType": { "additionalProperties": false, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" } }, "properties": { "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "TestFlag", "age", "email" ], "type": "object" }
MIT
en
invopop/jsonschema
e1afd7ef3abf40b7520d74a8d310d60d6b449574
2022-02-03T02:40:42
fixtures/go_comments.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/User", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "Pet": { "additionalProperties": false, "description": "Pet defines the user's fury friend.", "properties": { "name": { "description": "Name of the animal.", "title": "Name", "type": "string" } }, "required": [ "name" ], "type": "object" }, "Plant": { "additionalProperties": false, "description": "Plant represents the plants the user might have and serves as a test of structs inside a `type` set.", "properties": { "variant": { "title": "Variant", "type": "string" } }, "required": [ "variant" ], "type": "object" }, "User": { "additionalProperties": false, "description": "User is used as a base to provide tests for comments.", "properties": { "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "id": { "description": "Unique sequential identifier.", "type": "integer" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "pets": { "description": "An array of pets the user cares for.", "items": { "$ref": "#/definitions/Pet", "$schema": "http://json-schema.org/draft-04/schema#" }, "type": "array" }, "plants": { "description": "Set of plants that the user likes", "items": { "$ref": "#/definitions/Plant", "$schema": "http://json-schema.org/draft-04/schema#" }, "title": "Pants", "type": "array" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" } }, "required": [ "id", "name", "pets", "plants" ], "type": "object" } } }
MIT
en
invopop/jsonschema
4c3020b1ad06753f0e7309c4536230130b0f3583
2023-09-06T16:01:04
fixtures/oneof_ref.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "Server": { "additionalProperties": false, "properties": { "ip_address": { "oneOf": [ { "$ref": "#/$defs/ipv4" }, { "$ref": "#/$defs/ipv6" } ] }, "ip_address_any": { "anyOf": [ { "$ref": "#/$defs/ipv4" }, { "$ref": "#/$defs/ipv6" } ] }, "ip_addresses": { "items": { "oneOf": [ { "$ref": "#/$defs/ipv4" }, { "$ref": "#/$defs/ipv6" } ] }, "type": "array" }, "ip_addresses_any": { "items": { "anyOf": [ { "$ref": "#/$defs/ipv4" }, { "$ref": "#/$defs/ipv6" } ] }, "type": "array" } }, "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/server", "$ref": "#/$defs/Server", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
151e3c21f49d67ce78eec0136f0e821bd9dc55f2
2021-12-28T22:04:59
fixtures/custom_type_with_interface.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/CustomTypeFieldWithInterface", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "CustomTimeWithInterface": { "format": "date-time", "type": "string" }, "CustomTypeFieldWithInterface": { "additionalProperties": false, "properties": { "CreatedAt": { "$ref": "#/definitions/CustomTimeWithInterface", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": [ "CreatedAt" ], "type": "object" } } }
MIT
en
invopop/jsonschema
83a598aac4a08e3c6edb184fd40b3c690fd3f3a7
2022-07-21T22:47:45
fixtures/inlining_embedded.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "Inner": { "additionalProperties": false, "properties": { "Foo": { "type": "string" } }, "required": [ "Foo" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/outer-named", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "inner": { "$ref": "#/$defs/Inner" }, "text": { "type": "string" } }, "required": [ "inner" ], "type": "object" }
MIT
en
invopop/jsonschema
fbc1a8a523cdad28ed2301886471c0b3eff2490f
2022-02-03T02:25:44
fixtures/defaults_expanded_toplevel.json
457
2024-05-27T06:45:28.205821Z
{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "GrandfatherType": { "additionalProperties": false, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" } }, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1.0, 1.5, 2.0 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "readOnly": true, "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "offsets": { "items": { "enum": [ 1.570796, 3.141592, 6.283185 ], "type": "number" }, "type": "array" }, "password": { "type": "string", "writeOnly": true }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "photo2": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "priorities": { "items": { "enum": [ -1, 0, 1 ], "type": "integer" }, "type": "array" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "raw": { "additionalProperties": true }, "roles": { "items": { "enum": [ "admin", "moderator", "user" ], "type": "string" }, "type": "array" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "password", "TestFlag", "age", "email", "Baz", "color", "roles", "raw" ], "type": "object" }
MIT
en
invopop/jsonschema
a4408ec0e9e13a56fff7ddbfab426061c34caa4c
2023-09-06T19:39:07
fixtures/number_handling.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "NumberHandler": { "additionalProperties": false, "properties": { "float32": { "default": 12.5, "type": "number" }, "int64": { "default": 12, "type": "integer" } }, "required": [ "int64", "float32" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/number-handler", "$ref": "#/$defs/NumberHandler", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
9145459e837c0b427fa1babd0faaaf5097cd91db
2021-02-03T20:12:11
fixtures/schema_with_minimum.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/MinValue", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "MinValue": { "additionalProperties": false, "properties": { "value4": { "minimum": 0, "type": "integer" } }, "required": [ "value4" ], "type": "object" } } }
MIT
en
invopop/jsonschema
787cd8204a0da0e8654528ce47675c636893bfe7
2021-09-20T00:02:43
fixtures/allow_additional_props.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": true, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "offsets": { "items": { "enum": [ 1.570796, 3.141592, 6.283185 ], "type": "number" }, "type": "array" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "photo2": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "priorities": { "items": { "enum": [ -1, 0, 1 ], "type": "integer" }, "type": "array" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "raw": { "additionalProperties": true }, "roles": { "items": { "enum": [ "admin", "moderator", "user" ], "type": "string" }, "type": "array" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "TestFlag", "age", "email", "Baz", "color", "roles", "raw" ], "type": "object" } } }
MIT
en
invopop/jsonschema
6787b8074a9ea5594e2bae1d6c3496160b06c8b9
2022-02-14T11:33:20
fixtures/oneof.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "ChildOneOf": { "additionalProperties": false, "oneOf": [ { "required": [ "child1", "child4" ], "title": "group1" }, { "required": [ "child2", "child3" ], "title": "group2" } ], "properties": { "child1": { "type": "string" }, "child2": { "type": "string" }, "child3": { "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "child4": { "type": "string" } }, "type": "object" }, "RootOneOf": { "additionalProperties": false, "oneOf": [ { "required": [ "field1", "field4" ], "title": "group1" }, { "required": [ "field2" ], "title": "group2" } ], "properties": { "child": { "$ref": "#/$defs/ChildOneOf", "$schema": "http://json-schema.org/draft/2020-12/schema" }, "field1": { "type": "string" }, "field2": { "type": "string" }, "field3": { "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "field4": { "type": "string" } }, "type": "object" } }, "$ref": "#/$defs/RootOneOf", "$schema": "http://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
ee500fb7e13058beee8271f324ad557253acc113
2022-09-16T10:12:14
fixtures/anyof.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "ChildAnyOf": { "additionalProperties": false, "anyOf": [ { "required": [ "child1", "child4" ], "title": "group1" }, { "required": [ "child2", "child3" ], "title": "group2" } ], "properties": { "child1": { "type": "string" }, "child2": { "type": "string" }, "child3": { "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "child4": { "type": "string" } }, "type": "object" }, "RootAnyOf": { "additionalProperties": false, "anyOf": [ { "required": [ "field1", "field4" ], "title": "group1" }, { "required": [ "field2" ], "title": "group2" } ], "properties": { "child": { "$ref": "#/$defs/ChildAnyOf" }, "field1": { "type": "string" }, "field2": { "type": "string" }, "field3": { "anyOf": [ { "type": "string" }, { "type": "array" } ] }, "field4": { "type": "string" } }, "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/root-any-of", "$ref": "#/$defs/RootAnyOf", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
151e3c21f49d67ce78eec0136f0e821bd9dc55f2
2021-12-28T22:04:59
fixtures/custom_slice_type.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/CustomSliceOuter", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "CustomSliceOuter": { "additionalProperties": false, "properties": { "slice": { "$ref": "#/definitions/CustomSliceType", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": [ "slice" ], "type": "object" }, "CustomSliceType": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] } } }
MIT
en
invopop/jsonschema
fa819247876e6b20293e57d3eb98afed476e5a43
2022-05-09T22:09:34
fixtures/go_comments.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "NamedPets": { "description": "NamedPets is a map of animal names to pets.", "patternProperties": { ".*": { "$ref": "#/$defs/Pet" } }, "type": "object" }, "Pet": { "additionalProperties": false, "description": "Pet defines the user's fury friend.", "properties": { "name": { "description": "Name of the animal.", "title": "Name", "type": "string" } }, "required": [ "name" ], "type": "object" }, "Pets": { "description": "Pets is a collection of Pet objects.", "items": { "$ref": "#/$defs/Pet" }, "type": "array" }, "Plant": { "additionalProperties": false, "description": "Plant represents the plants the user might have and serves as a test of structs inside a `type` set.", "properties": { "variant": { "title": "Variant", "type": "string" } }, "required": [ "variant" ], "type": "object" }, "User": { "additionalProperties": false, "description": "User is used as a base to provide tests for comments.", "properties": { "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "id": { "description": "Unique sequential identifier.", "type": "integer" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "named_pets": { "$ref": "#/$defs/NamedPets", "description": "Set of animal names to pets" }, "pets": { "$ref": "#/$defs/Pets", "description": "An array of pets the user cares for." }, "plants": { "description": "Set of plants that the user likes", "items": { "$ref": "#/$defs/Plant" }, "title": "Plants", "type": "array" }, "tags": { "type": "object" } }, "required": [ "id", "name", "pets", "named_pets", "plants" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/examples/user", "$ref": "#/$defs/User", "$schema": "http://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
992e094365739d2e0d8031d9f273fd0f4b21729f
2023-10-13T15:55:10
fixtures/with_custom_format.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "WithCustomFormat": { "additionalProperties": false, "properties": { "dates": { "items": { "format": "date", "type": "string" }, "type": "array" }, "odds": { "items": { "format": "odd", "type": "string" }, "type": "array" } }, "required": [ "dates", "odds" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/with-custom-format", "$ref": "#/$defs/WithCustomFormat", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
12cbc49539c8deac9baeae7811fdcab42fd5def0
2023-10-04T08:45:54
fixtures/no_reference.json
457
2024-05-27T06:45:28.205821Z
{ "$id": "https://github.com/invopop/jsonschema/test-user", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "MapType": { "type": "object" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "TestFlagFalse": { "default": false, "type": "boolean" }, "TestFlagTrue": { "default": true, "type": "boolean" }, "age": { "exclusiveMaximum": 121, "exclusiveMinimum": 17, "maximum": 120, "minimum": 18, "type": "integer" }, "anything": true, "birth_date": { "format": "date-time", "type": "string" }, "bool_extra": { "isFalse": false, "isTrue": true, "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "additionalProperties": false, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "id": { "type": "integer" }, "mult": { "enum": [ 1.0, 1.5, 2.0 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "readOnly": true, "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "offsets": { "items": { "enum": [ 1.570796, 3.141592, 6.283185 ], "type": "number" }, "type": "array" }, "options": { "type": "object" }, "password": { "type": "string", "writeOnly": true }, "photo": { "contentEncoding": "base64", "type": "string" }, "photo2": { "contentEncoding": "base64", "type": "string" }, "priorities": { "items": { "enum": [ -1, 0, 1 ], "type": "integer" }, "type": "array" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "raw": true, "roles": { "items": { "enum": [ "admin", "moderator", "user" ], "type": "string" }, "type": "array" }, "some_base_property": { "type": "integer" }, "tags": { "additionalProperties": { "type": "string" }, "type": "object" }, "uuid": { "format": "uuid", "type": "string" }, "website": { "format": "uri", "type": "string" } }, "required": [ "id", "some_base_property", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "MapType", "name", "password", "TestFlag", "photo", "photo2", "age", "email", "uuid", "Baz", "color", "roles", "raw" ], "type": "object" }
MIT
en
invopop/jsonschema
151e3c21f49d67ce78eec0136f0e821bd9dc55f2
2021-12-28T22:04:59
fixtures/custom_map_type.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/CustomMapOuter", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "CustomMapOuter": { "additionalProperties": false, "properties": { "my_map": { "$ref": "#/definitions/CustomMapType", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": [ "my_map" ], "type": "object" }, "CustomMapType": { "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "type": "array" } } }
MIT
en
invopop/jsonschema
3adca1741eb43906119d730881e7241390577444
2020-01-23T07:54:51
fixtures/oneof.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/RootOneOf", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "ChildOneOf": { "additionalProperties": false, "oneOf": [ { "required": [ "child1", "child4" ], "title": "group1" }, { "required": [ "child2" ], "title": "group2" } ], "properties": { "child1": { "type": "string" }, "child2": { "type": "string" }, "child3": { "additionalProperties": true, "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "child4": { "type": "string" } }, "type": "object" }, "RootOneOf": { "additionalProperties": false, "oneOf": [ { "required": [ "field1", "field4" ], "title": "group1" }, { "required": [ "field2" ], "title": "group2" } ], "properties": { "child": { "$ref": "#/definitions/ChildOneOf", "$schema": "http://json-schema.org/draft-04/schema#" }, "field1": { "type": "string" }, "field2": { "type": "string" }, "field3": { "additionalProperties": true, "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "field4": { "type": "string" } }, "type": "object" } } }
MIT
en
invopop/jsonschema
530c7ec495a44ba3d94c5b49a19f1e278959af3b
2020-01-27T19:28:18
fixtures/ignore_type.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": {}, "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "Baz": { "foo": "bar", "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "TestFlag", "age", "email" ], "type": "object" } } }
MIT
en
invopop/jsonschema
a176ac1737cd502905bb0b77d36a89d0b3bfeee1
2022-02-13T15:49:12
fixtures/custom_map_type.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "CustomMapOuter": { "additionalProperties": false, "properties": { "my_map": { "$ref": "#/$defs/CustomMapType", "$schema": "http://json-schema.org/draft/2020-12/schema" } }, "required": [ "my_map" ], "type": "object" }, "CustomMapType": { "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "type": "array" } }, "$ref": "#/$defs/CustomMapOuter", "$schema": "http://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
3330865a0c6b1813bd90bd6255752e15bba096fe
2022-02-15T00:08:52
fixtures/custom_type_with_interface.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "CustomTimeWithInterface": { "format": "date-time", "type": "string" }, "CustomTypeFieldWithInterface": { "additionalProperties": false, "properties": { "CreatedAt": { "$ref": "#/$defs/CustomTimeWithInterface" } }, "required": [ "CreatedAt" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/custom-type-field-with-interface", "$ref": "#/$defs/CustomTypeFieldWithInterface", "$schema": "http://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
2fc8c2c65333dae5e8a94b90ae4776d49b9dcc34
2022-02-17T11:25:33
fixtures/commas_in_pattern.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/PatternTest", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "PatternTest": { "additionalProperties": false, "properties": { "with_pattern": { "maxLength": 50, "minLength": 1, "pattern": "[0-9]{1,4}", "type": "string" } }, "required": [ "with_pattern" ], "type": "object" } } }
MIT
en
invopop/jsonschema
83a598aac4a08e3c6edb184fd40b3c690fd3f3a7
2022-07-21T22:47:45
fixtures/user_with_anchor.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "UserWithAnchor": { "additionalProperties": false, "properties": { "name": { "$anchor": "Name", "type": "string" } }, "required": [ "name" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/user-with-anchor", "$ref": "#/$defs/UserWithAnchor", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
3330865a0c6b1813bd90bd6255752e15bba096fe
2022-02-15T00:08:52
fixtures/schema_with_minimum.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "MinValue": { "additionalProperties": false, "properties": { "value4": { "minimum": 0, "type": "integer" } }, "required": [ "value4" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/min-value", "$ref": "#/$defs/MinValue", "$schema": "http://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
8b29eab41725e31920734db930a42c6ce802da63
2021-10-22T21:42:03
fixtures/custom_map_type.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/CustomMapOuter", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "CustomMapOuter": { "additionalProperties": false, "properties": { "my_map": { "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "my_map" ], "type": "object" } } }
MIT
en
invopop/jsonschema
b0206aa42ef7921e95277fe9f3dc01e1807e0b86
2023-09-25T06:41:32
fixtures/ignore_type.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "Bytes": { "contentEncoding": "base64", "type": "string" }, "GrandfatherType": { "additionalProperties": false, "properties": {}, "type": "object" }, "MapType": { "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "MapType": { "$ref": "#/$defs/MapType" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "TestFlagFalse": { "default": false, "type": "boolean" }, "TestFlagTrue": { "default": true, "type": "boolean" }, "age": { "exclusiveMaximum": 121, "exclusiveMinimum": 17, "maximum": 120, "minimum": 18, "type": "integer" }, "anything": true, "birth_date": { "format": "date-time", "type": "string" }, "bool_extra": { "isFalse": false, "isTrue": true, "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/$defs/GrandfatherType" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "readOnly": true, "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "offsets": { "items": { "enum": [ 1.570796, 3.141592, 6.283185 ], "type": "number" }, "type": "array" }, "options": { "type": "object" }, "password": { "type": "string", "writeOnly": true }, "photo": { "contentEncoding": "base64", "type": "string" }, "photo2": { "$ref": "#/$defs/Bytes" }, "priorities": { "items": { "enum": [ -1, 0, 1 ], "type": "integer" }, "type": "array" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "raw": true, "roles": { "items": { "enum": [ "admin", "moderator", "user" ], "type": "string" }, "type": "array" }, "some_base_property": { "type": "integer" }, "tags": { "additionalProperties": { "type": "string" }, "type": "object" }, "uuid": { "format": "uuid", "type": "string" }, "website": { "format": "uri", "type": "string" } }, "required": [ "id", "some_base_property", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "MapType", "name", "password", "TestFlag", "photo", "photo2", "age", "email", "uuid", "Baz", "color", "roles", "raw" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/test-user", "$ref": "#/$defs/TestUser", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
2b3f409d9919322b03ee5aae5c96fcd862aba90b
2022-02-21T12:35:14
fixtures/base_schema_id.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "LookupName": { "additionalProperties": false, "properties": { "first": { "type": "string" }, "surname": { "type": "string" } }, "required": [ "first", "surname" ], "type": "object" }, "LookupUser": { "additionalProperties": false, "properties": { "alias": { "type": "string" }, "name": { "$ref": "#/$defs/LookupName" } }, "required": [ "name" ], "type": "object" } }, "$id": "https://example.com/schemas/lookup-user", "$ref": "#/$defs/LookupUser", "$schema": "http://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
e803ab25037d05b814b4b8ae313762cc1c75be79
2020-01-29T02:05:56
fixtures/ignore_type.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": {}, "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "Baz": { "foo": "bar", "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "TestFlag", "age", "email", "Baz", "color" ], "type": "object" } } }
MIT
en
invopop/jsonschema
04bb8d856292e626946ddedfb0538045b84b1343
2017-10-25T02:22:28
fixtures/defaults_expanded_toplevel.json
457
2024-05-27T06:45:28.205821Z
{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "GrandfatherType": { "additionalProperties": false, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" } }, "properties": { "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "name": { "maxLength": 20, "minLength": 1, "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "some_base_property": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "grand", "SomeUntaggedBaseProperty", "id", "name", "TestFlag", "age", "email" ], "type": "object" }
MIT
en
invopop/jsonschema
d29031c5d0877bed761b260142616fa9a701eb4a
2020-11-25T20:17:47
fixtures/required_from_jsontags.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": false, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "photo2": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "SomeUntaggedBaseProperty", "id", "name", "photo", "photo2" ], "type": "object" } } }
MIT
en
invopop/jsonschema
2b3f409d9919322b03ee5aae5c96fcd862aba90b
2022-02-21T12:35:14
fixtures/lookup.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "LookupUser": { "additionalProperties": false, "properties": { "alias": { "type": "string" }, "name": { "$ref": "https://example.com/schemas/lookup-name" } }, "required": [ "name" ], "type": "object" } }, "$id": "https://example.com/schemas/lookup-user", "$ref": "#/$defs/LookupUser", "$schema": "http://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
04bb8d856292e626946ddedfb0538045b84b1343
2017-10-25T02:22:28
fixtures/required_from_jsontags.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": false, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "name": { "maxLength": 20, "minLength": 1, "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "some_base_property": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "SomeUntaggedBaseProperty", "id", "name", "photo" ], "type": "object" } } }
MIT
en
invopop/jsonschema
fd8d96416671e33ef79358139312e88557a8aaab
2019-05-30T23:57:21
fixtures/allow_additional_props.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": true, "properties": { "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "TestFlag", "age", "email" ], "type": "object" } } }
MIT
en
invopop/jsonschema
1014919a589cb62aa9287aebd5a841726661e3ed
2021-08-18T09:53:45
fixtures/required_from_jsontags.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": false, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "offsets": { "items": { "enum": [ 1.570796, 3.141592, 6.283185 ], "type": "number" }, "type": "array" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "photo2": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "priorities": { "items": { "enum": [ -1, 0, 1 ], "type": "integer" }, "type": "array" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "roles": { "items": { "enum": [ "admin", "moderator", "user" ], "type": "string" }, "type": "array" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "SomeUntaggedBaseProperty", "id", "name", "photo", "photo2" ], "type": "object" } } }
MIT
en
invopop/jsonschema
fa80106e9fdaa7d66907c3db40628503a0528810
2019-04-27T06:12:45
fixtures/allow_additional_props.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": true, "properties": { "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "id", "name", "TestFlag", "age", "email" ], "type": "object" } } }
MIT
en
invopop/jsonschema
e6fc2822d59dca8a68927da95f2b6aa977e0a08e
2021-02-14T20:01:37
fixtures/custom_additional.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": false, "properties": { "family_name": { "type": "string" }, "ip_addr": { "format": "ipv4", "type": "string" } }, "required": [ "family_name", "ip_addr" ], "type": "object" } } }
MIT
en
invopop/jsonschema
96db623ed2c5cf99009f7e884163d35f519ba188
2022-03-02T20:43:51
fixtures/keynamed.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "KeyNamed": { "additionalProperties": false, "properties": { "20.01": { "description": "Description was preserved", "type": "integer" }, "ThisWasLeftAsIs": { "type": "string" }, "coming_from_json_tag": { "type": "boolean" }, "nested_not_renamed": { "$ref": "#/$defs/KeyNamedNested" }, "\u2728unicode\u2728 s\u0338\u035d\u0325h\u0337\u0352\u0333e\u0334\u033d\u031cn\u0338\u033f\u0321a\u0337\u0314\u0318n\u0337\u0350\u0318i\u0336\u0310\u032bg\u0336\u0341\u032fa\u0335\u0352\u0318n\u0337\u033e\u032es\u0338\u0343\u031f": { "type": "string" } }, "required": [ "ThisWasLeftAsIs", "coming_from_json_tag", "nested_not_renamed", "\u2728unicode\u2728 s\u0338\u035d\u0325h\u0337\u0352\u0333e\u0334\u033d\u031cn\u0338\u033f\u0321a\u0337\u0314\u0318n\u0337\u0350\u0318i\u0336\u0310\u032bg\u0336\u0341\u032fa\u0335\u0352\u0318n\u0337\u033e\u032es\u0338\u0343\u031f", "20.01" ], "type": "object" }, "KeyNamedNested": { "additionalProperties": false, "properties": { "NotRenamed": { "type": "string" }, "nested-renamed-property": { "type": "string" } }, "required": [ "nested-renamed-property", "NotRenamed" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/key-named", "$ref": "#/$defs/KeyNamed", "$schema": "http://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
83a598aac4a08e3c6edb184fd40b3c690fd3f3a7
2022-07-21T22:47:45
fixtures/custom_slice_type.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "CustomSliceOuter": { "additionalProperties": false, "properties": { "slice": { "$ref": "#/$defs/CustomSliceType" } }, "required": [ "slice" ], "type": "object" }, "CustomSliceType": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] } }, "$id": "https://github.com/invopop/jsonschema/custom-slice-outer", "$ref": "#/$defs/CustomSliceOuter", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
83a598aac4a08e3c6edb184fd40b3c690fd3f3a7
2022-07-21T22:47:45
fixtures/custom_type_with_interface.json
457
2024-05-27T06:45:28.205821Z
{ "$defs": { "CustomTimeWithInterface": { "format": "date-time", "type": "string" }, "CustomTypeFieldWithInterface": { "additionalProperties": false, "properties": { "CreatedAt": { "$ref": "#/$defs/CustomTimeWithInterface" } }, "required": [ "CreatedAt" ], "type": "object" } }, "$id": "https://github.com/invopop/jsonschema/custom-type-field-with-interface", "$ref": "#/$defs/CustomTypeFieldWithInterface", "$schema": "https://json-schema.org/draft/2020-12/schema" }
MIT
en
invopop/jsonschema
edb03dcab7bc2884de8ef57016a9fa031135ba8c
2021-05-26T22:56:47
fixtures/compact_date.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/CompactDate", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "CompactDate": { "description": "Short date that only includes year and month", "pattern": "^[0-9]{4}-[0-1][0-9]$", "title": "Compact Date", "type": "string" } } }
MIT
en
invopop/jsonschema
159cbd5dba2666b7dfd18fa214dfb0c86625280f
2019-05-04T00:25:08
fixtures/ignore_type.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": {}, "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "id", "name", "TestFlag", "age", "email" ], "type": "object" } } }
MIT
en
invopop/jsonschema
0366d1034a17e261f9c87cefd7adeafcfae86822
2020-05-14T01:46:46
fixtures/ignore_type.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": {}, "type": "object" }, "TestUser": { "additionalProperties": false, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "TestFlag", "age", "email", "Baz", "color" ], "type": "object" } } }
MIT
en
invopop/jsonschema
fbc1a8a523cdad28ed2301886471c0b3eff2490f
2022-02-03T02:25:44
fixtures/allow_additional_props.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": true, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "readOnly": true, "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "offsets": { "items": { "enum": [ 1.570796, 3.141592, 6.283185 ], "type": "number" }, "type": "array" }, "password": { "type": "string", "writeOnly": true }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "photo2": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "priorities": { "items": { "enum": [ -1, 0, 1 ], "type": "integer" }, "type": "array" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "raw": { "additionalProperties": true }, "roles": { "items": { "enum": [ "admin", "moderator", "user" ], "type": "string" }, "type": "array" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "password", "TestFlag", "age", "email", "Baz", "color", "roles", "raw" ], "type": "object" } } }
MIT
en
invopop/jsonschema
d29031c5d0877bed761b260142616fa9a701eb4a
2020-11-25T20:17:47
fixtures/allow_additional_props.json
457
2024-05-27T06:45:28.205821Z
{ "$ref": "#/definitions/TestUser", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "GrandfatherType": { "additionalProperties": true, "properties": { "family_name": { "type": "string" } }, "required": [ "family_name" ], "type": "object" }, "TestUser": { "additionalProperties": true, "properties": { "Baz": { "foo": [ "bar", "bar1" ], "hello": "world", "type": "string" }, "PublicNonExported": { "type": "integer" }, "SomeUntaggedBaseProperty": { "type": "boolean" }, "TestFlag": { "type": "boolean" }, "age": { "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 120, "minimum": 18, "type": "integer" }, "birth_date": { "format": "date-time", "type": "string" }, "color": { "enum": [ "red", "green", "blue" ], "type": "string" }, "email": { "format": "email", "type": "string" }, "feeling": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "friends": { "description": "list of IDs, omitted when empty", "items": { "type": "integer" }, "type": "array" }, "grand": { "$ref": "#/definitions/GrandfatherType", "$schema": "http://json-schema.org/draft-04/schema#" }, "id": { "type": "integer" }, "mult": { "enum": [ 1, 1.5, 2 ], "type": "number" }, "name": { "default": "alex", "description": "this is a property", "examples": [ "joe", "lucy" ], "maxLength": 20, "minLength": 1, "pattern": ".*", "title": "the name", "type": "string" }, "network_address": { "format": "ipv4", "type": "string" }, "photo": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "photo2": { "media": { "binaryEncoding": "base64" }, "type": "string" }, "rank": { "enum": [ 1, 2, 3 ], "type": "integer" }, "some_base_property": { "type": "integer" }, "some_base_property_yaml": { "type": "integer" }, "tags": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "website": { "format": "uri", "type": "string" } }, "required": [ "some_base_property", "some_base_property_yaml", "grand", "SomeUntaggedBaseProperty", "PublicNonExported", "id", "name", "TestFlag", "age", "email", "Baz", "color" ], "type": "object" } } }
MIT
en
hpcc-systems/helm-chart
552604426744a128c809bde078a528060d0e2a86
2023-01-13T16:04:09
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "oneOf": [ { "description": "Named egress section (from global.egress) to apply to this component", "type": "string" }, { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" } ] }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/globalEgress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Settings for developers, debugging and testing" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "globalEgress": { "additionalProperties": { "properties": { "additionalProperties": false, "egress": { "$ref": "#/definitions/egress" } }, "type": "array" }, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "keyColumn": { "description": "Name of join key column", "type": "string" }, "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "egress": {}, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "storageapi": {}, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageapi": { "additionalProperties": false, "description": "Optional information for storage api", "properties": { "account": { "description": "Account name", "type": "string" }, "containers": { "description": "List of containers", "items": { "additionalProperties": false, "description": "storage container/file share (one item for each device)", "properties": { "account": { "description": "Acccount Name (optional - will default to parent object if not specified)", "type": "string" }, "name": { "description": "Name of storage container/file share", "type": "string" }, "secret": { "description": "Secret id (optional - will default to parent object if not specified)", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "secret": { "description": "Secret id", "type": "string" }, "type": { "description": "Type of storage api", "enum": [ "azurefile", "azureblob" ], "type": "string" } }, "required": [ "type", "containers" ], "type": "object" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker containers. NB: There will be <numWorker>/<numWorkersPerPod> pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "namespace": { "description": "the namespace to use when authenticating with, and accessing the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
b7a69836a25f2a9e9dcc76582978485e82cd5b55
2022-09-29T15:39:24
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
78859f837352a7d12dba201b1cc3e04be7048b43
2022-04-06T15:49:40
helm/examples/local/hpcc-localfile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "numDevices": { "description": "the number of pvcs to create (allowing sub-directories on different devices)", "type": "integer" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "hostpath": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
3cab008371d2512dc00a64af32ccfc63540885f6
2020-06-11T15:44:39
helm/examples/local/hpcc-localfile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "storage": { "additionalProperties": false, "properties": { "hostpath": { "type": "string" }, "size": { "type": "string" } }, "required": [ "size" ], "type": "object" } }, "properties": { "common": { "properties": { "hostpath": { "type": "string" } }, "type": "object" }, "daliStorage": { "$ref": "#/definitions/storage" }, "dataStorage": { "$ref": "#/definitions/storage" }, "dllStorage": { "$ref": "#/definitions/storage" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7a28af475093e72c5b90c8f8fc74237793eea0eb
2022-03-24T09:42:22
helm/examples/nfs/hpcc-nfs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "namespace": { "type": "string" }, "planes": { "description": "List of storage planes", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] }, "sharedStorage": { "additionalProperties": false, "properties": { "existingClaim": { "type": "string" }, "size": { "type": "string" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
c6dd33a4c5ff157605abe605e50c3c7c012d90d8
2022-10-24T16:28:41
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "storageapi": {}, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageapi": { "description": "Optional information for storage api", "properties": { "account": { "description": "Account name", "type": "string" }, "containers": { "description": "List of containers", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "Secret id", "type": "string" }, "type": { "description": "Type of storage api", "enum": [ "azurefile", "azureblob" ], "type": "string" } }, "type": "object" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker containers. NB: There will be <numWorker>/<numWorkersPerPod> pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7b64a07e918f354559b0f743eeec6cba185199ca
2022-03-30T14:44:57
helm/examples/azure/hpcc-azurefile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "shareName": { "description": "Azure storage share name", "type": "string" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" }, "secretName": { "description": "Kubernetes secret name for Azure storage account", "type": "string" }, "secretNamespace": { "default": "default", "description": "Kubernetes namespace for secret", "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
8fa75efb495d584d7ec51fa7bcf176a5ce1a1f05
2022-11-24T15:14:59
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "oneOf": [ { "description": "Named egress section (from global.egress) to apply to this component", "type": "string" }, { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" } ] }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/globalEgress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "globalEgress": { "additionalProperties": { "properties": { "additionalProperties": false, "egress": { "$ref": "#/definitions/egress" } }, "type": "array" }, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "egress": {}, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "storageapi": {}, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageapi": { "additionalProperties": false, "description": "Optional information for storage api", "properties": { "account": { "description": "Account name", "type": "string" }, "containers": { "description": "List of containers", "items": { "additionalProperties": false, "description": "storage container/file share (one item for each device)", "properties": { "account": { "description": "Acccount Name (optional - will default to parent object if not specified)", "type": "string" }, "name": { "description": "Name of storage container/file share", "type": "string" }, "secret": { "description": "Secret id (optional - will default to parent object if not specified)", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "secret": { "description": "Secret id", "type": "string" }, "type": { "description": "Type of storage api", "enum": [ "azurefile", "azureblob" ], "type": "string" } }, "required": [ "type", "containers" ], "type": "object" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker containers. NB: There will be <numWorker>/<numWorkersPerPod> pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
edf8b25fccbd1956a7be55f58ae458672c358e66
2021-05-12T16:02:36
helm/examples/filestore/hpcc-filestore/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "nfs": { "properties": { "path": { "description": "nfs exported path", "type": "string" }, "server": { "description": "nfs server ip", "type": "string" } }, "required": [ "server", "path" ], "type": "object" }, "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" }, "storageClass": { "properties": { "accessModes": { "description": "One ReadWriteMany, ReadWriteOnce and ReadOnlyMany", "type": "string" }, "reclaimPolicy": { "description": "one of Retain, Recycl adn Delete. The default is Delete", "type": "string" } }, "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "nfs-subdir-external-provisioner": { "properties": { "nfs": { "$ref": "#/definitions/nfs" }, "storageClass": { "$ref": "#/definitions/storageClass" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
299ed95026fcc73c994ff57e685ded384926cba2
2021-04-21T16:59:28
helm/examples/efs/hpcc-efs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7b64a07e918f354559b0f743eeec6cba185199ca
2022-03-30T14:44:57
helm/examples/efs/hpcc-efs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
5e8aa5664ce367cd87745aab684fffc5ce6a8001
2022-03-02T13:45:09
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "service": { "description": "the remote DFS service", "type": "string" } }, "required": [ "name", "service", "planes" ], "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "default": 1073741824, "description": "Maximum amount of memory available for row data in all active queries", "minimum": 0, "type": "integer" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "additionalProperties": false, "description": "information about an individual storage plane", "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } }, "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "ecl-user": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
686bcb4582cb86f1c64d138d354767571fc81c28
2022-05-13T14:44:34
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "default": "1G", "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
0876a22886ea3b3fab6fec7fea280a1bae707c6f
2022-09-12T16:21:07
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
3cab008371d2512dc00a64af32ccfc63540885f6
2020-06-11T15:44:39
helm/examples/nfs/hpcc-nfs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "storage": { "additionalProperties": false, "properties": { "size": { "type": "string" }, "sku": { "type": "string" } }, "required": [ "size" ], "type": "object" } }, "properties": { "daliStorage": { "$ref": "#/definitions/storage" }, "dataStorage": { "$ref": "#/definitions/storage" }, "dllStorage": { "$ref": "#/definitions/storage" }, "sharedStorage": { "additionalProperties": false, "properties": { "existingClaim": { "type": "string" }, "size": { "type": "string" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
45d4593993ba769f32ac55008585484c0ec4231a
2021-07-02T14:38:49
helm/examples/local/hpcc-localfile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "hostpath": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7a28af475093e72c5b90c8f8fc74237793eea0eb
2022-03-24T09:42:22
helm/examples/efs/hpcc-efs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7b64a07e918f354559b0f743eeec6cba185199ca
2022-03-30T14:44:57
helm/examples/local/hpcc-localfile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "hostpath": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7b64a07e918f354559b0f743eeec6cba185199ca
2022-03-30T14:44:57
helm/examples/filestore/hpcc-filestore/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "nfs": { "properties": { "path": { "description": "nfs exported path", "type": "string" }, "server": { "description": "nfs server ip", "type": "string" } }, "required": [ "server", "path" ], "type": "object" }, "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" }, "storageClass": { "properties": { "accessModes": { "description": "One ReadWriteMany, ReadWriteOnce and ReadOnlyMany", "type": "string" }, "reclaimPolicy": { "description": "one of Retain, Recycl adn Delete. The default is Delete", "type": "string" } }, "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "nfs-subdir-external-provisioner": { "properties": { "nfs": { "$ref": "#/definitions/nfs" }, "storageClass": { "$ref": "#/definitions/storageClass" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
45d4593993ba769f32ac55008585484c0ec4231a
2021-07-02T14:38:49
helm/examples/nfs/hpcc-nfs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "namespace": { "type": "string" }, "planes": { "description": "List of storage planes", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] }, "sharedStorage": { "additionalProperties": false, "properties": { "existingClaim": { "type": "string" }, "size": { "type": "string" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
b471d9fc6804b330d51a1039d79d753e272ce293
2022-03-09T13:54:58
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "default": 1073741824, "description": "Maximum amount of memory available for row data in all active queries", "minimum": 0, "type": "integer" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "additionalProperties": false, "description": "information about an individual storage plane", "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } }, "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "ecl-user": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
247520fb4d5a1d0a19357559fec5fda760ca3247
2022-02-17T15:28:43
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "service": { "description": "the remote DFS service", "type": "string" } }, "required": [ "name", "service", "planes" ], "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "default": 1073741824, "description": "Maximum amount of memory available for row data in all active queries", "minimum": 0, "type": "integer" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "additionalProperties": false, "description": "information about an individual storage plane", "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote" ], "type": "string" }, "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "forcePermissions": { "type": "boolean" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } }, "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "ecl-user": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7b64a07e918f354559b0f743eeec6cba185199ca
2022-03-30T14:44:57
helm/examples/nfs/hpcc-nfs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "namespace": { "type": "string" }, "planes": { "description": "List of storage planes", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] }, "sharedStorage": { "additionalProperties": false, "properties": { "existingClaim": { "type": "string" }, "size": { "type": "string" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
36758f34874a3a5fc1658cd28a575f5560a4d842
2022-08-24T15:39:56
helm/examples/azure/hpcc-azurefile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "secretName": { "description": "Kubernetes secret name to use for the Azure storage account for this plane", "type": "string" }, "secretNamespace": { "description": "Kubernetes namespace for the Kubernetes secret named by secretName", "type": "string" }, "shareName": { "description": "Azure storage share name", "type": "string" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" }, "volumeId": { "description": "make sure this volumeid is unique in the cluster", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" }, "provisioner": { "default": "file.csi.azure.com", "description": "StorageClass provisioner determines what volume plugin is used for provisioning PVs", "type": "string" }, "secretName": { "description": "Kubernetes secret name for Azure storage account", "type": "string" }, "secretNamespace": { "default": "default", "description": "Kubernetes namespace for secret", "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
349f93d63c1b8ffc82f8a69769e984075260e5b1
2023-01-09T21:23:38
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "oneOf": [ { "description": "Named egress section (from global.egress) to apply to this component", "type": "string" }, { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" } ] }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/globalEgress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "globalEgress": { "additionalProperties": { "properties": { "additionalProperties": false, "egress": { "$ref": "#/definitions/egress" } }, "type": "array" }, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "keyColumn": { "description": "Name of join key column", "type": "string" }, "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "egress": {}, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "storageapi": {}, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageapi": { "additionalProperties": false, "description": "Optional information for storage api", "properties": { "account": { "description": "Account name", "type": "string" }, "containers": { "description": "List of containers", "items": { "additionalProperties": false, "description": "storage container/file share (one item for each device)", "properties": { "account": { "description": "Acccount Name (optional - will default to parent object if not specified)", "type": "string" }, "name": { "description": "Name of storage container/file share", "type": "string" }, "secret": { "description": "Secret id (optional - will default to parent object if not specified)", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "secret": { "description": "Secret id", "type": "string" }, "type": { "description": "Type of storage api", "enum": [ "azurefile", "azureblob" ], "type": "string" } }, "required": [ "type", "containers" ], "type": "object" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker containers. NB: There will be <numWorker>/<numWorkersPerPod> pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "namespace": { "description": "the namespace to use when authenticating with, and accessing the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
e3725b1a4d58d39b405d7a82cf5269ad2171c7c6
2021-05-19T16:18:46
helm/examples/nfs/hpcc-nfs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "namespace": { "type": "string" }, "planes": { "description": "List of storage planes", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] }, "sharedStorage": { "additionalProperties": false, "properties": { "existingClaim": { "type": "string" }, "size": { "type": "string" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
8c6a7a897e3c158a78f51e6c36e263788cbbcdb2
2022-07-21T14:04:14
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
48f60999c0b5946830d89a648b8da3188f5a2ec2
2021-04-01T13:12:08
helm/examples/local/hpcc-localfile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "hostpath": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
d3a2b60520475f647801e087473960bf74e3be21
2021-08-26T12:19:30
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" } }, "required": [ "name", "service" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "resource cost", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory system administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory system administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory systemUser", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "channelResources": { "$ref": "#/definitions/resources" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the roxie process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "serverResources": { "$ref": "#/definitions/resources" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "storagePlanes": { "description": "A list of storage planes suitable for storing roxie data", "items": { "type": "string" }, "type": "array" }, "topoServer": { "$ref": "#/definitions/toposerver" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "additionalProperties": false, "description": "information about an individual storage plane", "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill" ], "type": "string" }, "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "forcePermissions": { "type": "boolean" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } }, "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "ecl-user": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7ea17f7179ecbb474168c0771982a9659befff5b
2023-02-13T17:02:05
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "oneOf": [ { "description": "Named egress section (from global.egress) to apply to this component", "type": "string" }, { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" } ] }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/globalEgress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Settings for developers, debugging and testing" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "globalEgress": { "additionalProperties": { "properties": { "additionalProperties": false, "egress": { "$ref": "#/definitions/egress" } }, "type": "array" }, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "keyColumn": { "description": "Name of join key column", "type": "string" }, "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" }, "organization": { "description": "Remote client organization", "type": "string" }, "secretTemplate": { "description": "cert-manager secretTemplate for this remoteClient secret", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "egress": {}, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "storageapi": {}, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageapi": { "additionalProperties": false, "description": "Optional information for storage api", "properties": { "account": { "description": "Account name", "type": "string" }, "containers": { "description": "List of containers", "items": { "additionalProperties": false, "description": "storage container/file share (one item for each device)", "properties": { "account": { "description": "Acccount Name (optional - will default to parent object if not specified)", "type": "string" }, "name": { "description": "Name of storage container/file share", "type": "string" }, "secret": { "description": "Secret id (optional - will default to parent object if not specified)", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "secret": { "description": "Secret id", "type": "string" }, "type": { "description": "Type of storage api", "enum": [ "azurefile", "azureblob" ], "type": "string" } }, "required": [ "type", "containers" ], "type": "object" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker containers. NB: There will be <numWorker>/<numWorkersPerPod> pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "namespace": { "description": "the namespace to use when authenticating with, and accessing the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" }, "verify_server": { "description": "optional relax server verification for trouble shooting", "type": "boolean" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "git": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
aecede07c12f1936827a65fa67be8edd061b1530
2020-09-16T14:00:30
helm/examples/nfs/hpcc-nfs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "storage": { "additionalProperties": false, "properties": { "size": { "type": "string" }, "sku": { "type": "string" } }, "required": [ "size" ], "type": "object" } }, "properties": { "daliStorage": { "$ref": "#/definitions/storage" }, "dataStorage": { "$ref": "#/definitions/storage" }, "dllStorage": { "$ref": "#/definitions/storage" }, "namespace": { "type": "string" }, "sharedStorage": { "additionalProperties": false, "properties": { "existingClaim": { "type": "string" }, "size": { "type": "string" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
bc9cdae02ad20d01eb7b2f053a0e20bca7b613fc
2022-08-30T16:47:35
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
45d4593993ba769f32ac55008585484c0ec4231a
2021-07-02T14:38:49
helm/examples/filestore/hpcc-filestore/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "nfs": { "properties": { "path": { "description": "nfs exported path", "type": "string" }, "server": { "description": "nfs server ip", "type": "string" } }, "required": [ "server", "path" ], "type": "object" }, "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" }, "storageClass": { "properties": { "accessModes": { "description": "One ReadWriteMany, ReadWriteOnce and ReadOnlyMany", "type": "string" }, "reclaimPolicy": { "description": "one of Retain, Recycl adn Delete. The default is Delete", "type": "string" } }, "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "nfs-subdir-external-provisioner": { "properties": { "nfs": { "$ref": "#/definitions/nfs" }, "storageClass": { "$ref": "#/definitions/storageClass" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7b9619579fb5be531eecbeb0713c242420383a86
2022-02-02T16:55:25
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "channelResources": { "$ref": "#/definitions/resources" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the roxie process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "serverResources": { "$ref": "#/definitions/resources" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "topoServer": { "$ref": "#/definitions/toposerver" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "additionalProperties": false, "description": "information about an individual storage plane", "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill" ], "type": "string" }, "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "forcePermissions": { "type": "boolean" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } }, "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "ecl-user": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
4e79da2ce1f57dacf86c47e87f56d6440571eb7a
2022-08-08T13:00:34
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7a28af475093e72c5b90c8f8fc74237793eea0eb
2022-03-24T09:42:22
helm/examples/local/hpcc-localfile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "hostpath": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
5f7ae0438ef1eedab498b8136ba1ceebb106f0be
2023-01-27T09:50:09
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "oneOf": [ { "description": "Named egress section (from global.egress) to apply to this component", "type": "string" }, { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" } ] }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/globalEgress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Settings for developers, debugging and testing" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "globalEgress": { "additionalProperties": { "properties": { "additionalProperties": false, "egress": { "$ref": "#/definitions/egress" } }, "type": "array" }, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "keyColumn": { "description": "Name of join key column", "type": "string" }, "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" }, "organization": { "description": "Remote client organization", "type": "string" }, "secretTemplate": { "description": "cert-manager secretTemplate for this remoteClient secret", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "egress": {}, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "storageapi": {}, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageapi": { "additionalProperties": false, "description": "Optional information for storage api", "properties": { "account": { "description": "Account name", "type": "string" }, "containers": { "description": "List of containers", "items": { "additionalProperties": false, "description": "storage container/file share (one item for each device)", "properties": { "account": { "description": "Acccount Name (optional - will default to parent object if not specified)", "type": "string" }, "name": { "description": "Name of storage container/file share", "type": "string" }, "secret": { "description": "Secret id (optional - will default to parent object if not specified)", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "secret": { "description": "Secret id", "type": "string" }, "type": { "description": "Type of storage api", "enum": [ "azurefile", "azureblob" ], "type": "string" } }, "required": [ "type", "containers" ], "type": "object" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker containers. NB: There will be <numWorker>/<numWorkersPerPod> pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "namespace": { "description": "the namespace to use when authenticating with, and accessing the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" }, "verify_server": { "description": "optional relax server verification for trouble shooting", "type": "boolean" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
644475ca0a22ba449e5af83c1b004462196c43dd
2022-06-24T15:51:27
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
8c6a7a897e3c158a78f51e6c36e263788cbbcdb2
2022-07-21T14:04:14
helm/examples/azure/hpcc-azurefile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "secretName": { "description": "Kubernetes secret name to use for the Azure storage account for this plane", "type": "string" }, "secretNamespace": { "description": "Kubernetes namespace for the Kubernetes secret named by secretName", "type": "string" }, "shareName": { "description": "Azure storage share name", "type": "string" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" }, "volumeId": { "description": "make sure this volumeid is unique in the cluster", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" }, "provisioner": { "default": "file.csi.azure.com", "description": "StorageClass provisioner determines what volume plugin is used for provisioning PVs", "type": "string" }, "secretName": { "description": "Kubernetes secret name for Azure storage account", "type": "string" }, "secretNamespace": { "default": "default", "description": "Kubernetes namespace for secret", "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7a28af475093e72c5b90c8f8fc74237793eea0eb
2022-03-24T09:42:22
helm/examples/azure/hpcc-azurefile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
e8eaa82649e2770dbdc12842c8cbe03f53e9e5c5
2023-04-27T16:04:58
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "oneOf": [ { "description": "Named egress section (from global.egress) to apply to this component", "type": "string" }, { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" } ] }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/globalEgress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Settings for developers, debugging and testing" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "globalEgress": { "additionalProperties": { "properties": { "additionalProperties": false, "egress": { "$ref": "#/definitions/egress" } }, "type": "array" }, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "disableJoins": { "description": "Disables expensive table join operations", "type": "boolean" }, "keyColumn": { "description": "Name of join key column", "type": "string" }, "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" }, "organization": { "description": "Remote client organization", "type": "string" }, "secretTemplate": { "description": "cert-manager secretTemplate for this remoteClient secret", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "egress": {}, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "storageapi": {}, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageapi": { "additionalProperties": false, "description": "Optional information for storage api", "properties": { "account": { "description": "Account name", "type": "string" }, "containers": { "description": "List of containers", "items": { "additionalProperties": false, "description": "storage container/file share (one item for each device)", "properties": { "account": { "description": "Acccount Name (optional - will default to parent object if not specified)", "type": "string" }, "name": { "description": "Name of storage container/file share", "type": "string" }, "secret": { "description": "Secret id (optional - will default to parent object if not specified)", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "secret": { "description": "Secret id", "type": "string" }, "type": { "description": "Type of storage api", "enum": [ "azurefile", "azureblob" ], "type": "string" } }, "required": [ "type", "containers" ], "type": "object" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker containers. NB: There will be <numWorker>/<numWorkersPerPod> pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "namespace": { "description": "the namespace to use when authenticating with, and accessing the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" }, "verify_server": { "description": "optional relax server verification for trouble shooting", "type": "boolean" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "git": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
36758f34874a3a5fc1658cd28a575f5560a4d842
2022-08-24T15:39:56
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
2386295530a1a12eb818e030f1e1d6c87f50c51f
2022-08-16T15:52:55
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
5a6b0ca837302b9e52f6ce13741a9eaf66091ec3
2022-06-17T15:54:46
helm/examples/azure/hpcc-azurefile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "secretName": { "description": "Kubernetes secret name to use for the Azure storage account for this plane", "type": "string" }, "secretNamespace": { "description": "Kubernetes namespace for the Kubernetes secret named by secretName", "type": "string" }, "shareName": { "description": "Azure storage share name", "type": "string" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" }, "secretName": { "description": "Kubernetes secret name for Azure storage account", "type": "string" }, "secretNamespace": { "default": "default", "description": "Kubernetes namespace for secret", "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
3cab008371d2512dc00a64af32ccfc63540885f6
2020-06-11T15:44:39
helm/examples/azure/hpcc-azurefile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "storage": { "additionalProperties": false, "properties": { "size": { "type": "string" }, "sku": { "type": "string" } }, "required": [ "size" ], "type": "object" } }, "properties": { "daliStorage": { "$ref": "#/definitions/storage" }, "dataStorage": { "$ref": "#/definitions/storage" }, "dllStorage": { "$ref": "#/definitions/storage" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7a28af475093e72c5b90c8f8fc74237793eea0eb
2022-03-24T09:42:22
helm/examples/filestore/hpcc-filestore/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "nfs": { "properties": { "path": { "description": "nfs exported path", "type": "string" }, "server": { "description": "nfs server ip", "type": "string" } }, "required": [ "server", "path" ], "type": "object" }, "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" }, "storageClass": { "properties": { "accessModes": { "description": "One ReadWriteMany, ReadWriteOnce and ReadOnlyMany", "type": "string" }, "reclaimPolicy": { "description": "one of Retain, Recycl adn Delete. The default is Delete", "type": "string" } }, "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "nfs-subdir-external-provisioner": { "properties": { "nfs": { "$ref": "#/definitions/nfs" }, "storageClass": { "$ref": "#/definitions/storageClass" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
2386295530a1a12eb818e030f1e1d6c87f50c51f
2022-08-16T15:52:55
helm/examples/azure/hpcc-azurefile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "secretName": { "description": "Kubernetes secret name to use for the Azure storage account for this plane", "type": "string" }, "secretNamespace": { "description": "Kubernetes namespace for the Kubernetes secret named by secretName", "type": "string" }, "shareName": { "description": "Azure storage share name", "type": "string" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" }, "secretName": { "description": "Kubernetes secret name for Azure storage account", "type": "string" }, "secretNamespace": { "default": "default", "description": "Kubernetes namespace for secret", "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
232f5b2c3ce1e0577eed62e7e744d1fd34ae1296
2020-07-22T14:51:27
helm/examples/efs/hpcc-efs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "efs": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "image": { "type": "string" }, "namespace": { "type": "string" }, "region": { "type": "string" }, "serviceaccount": { "type": "string" } }, "required": [ "id", "region", "image" ], "type": "object" }, "storage": { "additionalProperties": false, "properties": { "size": { "type": "string" }, "sku": { "type": "string" } }, "required": [ "size" ], "type": "object" } }, "properties": { "daliStorage": { "$ref": "#/definitions/storage" }, "dataStorage": { "$ref": "#/definitions/storage" }, "dllStorage": { "$ref": "#/definitions/storage" }, "efs": { "$ref": "#/definitions/efs" } } }
Apache-2.0
en
hpcc-systems/helm-chart
78d5e17c8bfc0e8f49b7b0bfb30646f8922ee3be
2022-11-14T17:31:15
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authDomain": { "additionalProperties": { "type": [ "integer", "string" ] }, "type": "object" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "corsAllowed": { "items": { "properties": { "headers": { "description": "a list of CORS allowed headers", "items": { "type": "string" }, "type": "array" }, "methods": { "description": "a list of CORS allowed HTTP methods (default is GET, POST, OPTIONS)", "items": { "type": "string" }, "type": "array" }, "origin": { "description": "CORS allowed origin", "type": "string" } }, "type": "object" }, "type": "array" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "application": { "description": "Application type", "enum": [ "stream", "directio", "spray" ], "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "application", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "oneOf": [ { "description": "Named egress section (from global.egress) to apply to this component", "type": "string" }, { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" } ] }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authDomain": { "$ref": "#/definitions/authDomain" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "corsAllowed": { "$ref": "#/definitions/corsAllowed" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/globalEgress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "globalEgress": { "additionalProperties": { "properties": { "additionalProperties": false, "egress": { "$ref": "#/definitions/egress" } }, "type": "array" }, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" }, "queueDrop": { "default": 0, "description": "Number of log entries to drop from the log queue when it is full. Disabled if 0, or if queueLength is 0", "type": "integer" }, "queueLength": { "default": 512, "description": "Maximum number of log entries to buffer in the log queue. Set to 0 for synchronous logging", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfurecovery-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, "sasha-dfuwu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "egress": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sasha-file-expiry": { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "egress": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "egress": {}, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "storageapi": {}, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "storageapi": { "description": "Optional information for storage api", "properties": { "account": { "description": "Account name", "type": "string" }, "containers": { "description": "List of containers", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "Secret id", "type": "string" }, "type": { "description": "Type of storage api", "enum": [ "azurefile", "azureblob" ], "type": "string" } }, "type": "object" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphStartupTime": { "default": 600, "description": "[Optional] The time (seconds) for the job to wait for a Thor instance to start", "type": "integer" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker containers. NB: There will be <numWorker>/<numWorkersPerPod> pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "appRoleId": { "description": "app role id assigned for use with Hashicorp appRole authentication", "type": "string" }, "appRoleSecret": { "description": "name of the secret that will contain the 'secret-id' used with Hashicorp appRole authentication", "type": "string" }, "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "sprayServiceName": { "description": "Optional name of the dafilesrv spray service to use (will default to 1st 'spray' dafilesrv)", "type": "string" }, "useFtSlave": { "default": false, "description": "Use legacy ftslave processes (ran within dfuserver pod)", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "esp": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
b3f1ae17da26221d3ef6dd8388723a599a06c63f
2022-04-08T13:35:47
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "default": "1G", "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "ecl-user": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
299ed95026fcc73c994ff57e685ded384926cba2
2021-04-21T16:59:28
helm/examples/azure/hpcc-azurefile/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "labels": { "description": "a list of labels associated with this plane, e.g. lz, data", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
45d4593993ba769f32ac55008585484c0ec4231a
2021-07-02T14:38:49
helm/examples/efs/hpcc-efs/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "plane": { "additionalProperties": false, "properties": { "category": { "description": "the category this plane is usd for, e.g. lz, data", "type": "string" }, "name": { "description": "Prefix for the pvc name", "type": "string" }, "rwmany": { "description": "Does the pvc require rw many access (data/dll currently)", "type": "boolean" }, "size": { "description": "Size that is required for the volume", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "sku": { "type": "string" }, "subPath": { "description": "sub path from common.hostpath on host where the pvc is created", "type": "string" } }, "required": [ "name", "subPath", "size" ], "type": "object" } }, "properties": { "common": { "properties": { "commonPrefix": { "type": "string" } }, "type": "object" }, "planes": { "description": "List of planes to mount locally", "oneOf": [ { "items": { "$ref": "#/definitions/plane" }, "type": "array" }, { "type": "null" } ] } }, "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
7bc91b325ca301e9019b008144b3df8c2fc6cbd6
2022-07-06T15:25:41
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "defaultRepo": { "description": "The default package/repo used to resolve code if not compiling from an archive", "type": "string" }, "defaultRepoVersion": { "description": "The default repo version used if not supplied for the defaultRepo", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "busybox": { "default": "busybox:stable", "description": "image for busybox containers", "type": "string" }, "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "eclUser": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "eclUser": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en
hpcc-systems/helm-chart
78859f837352a7d12dba201b1cc3e04be7048b43
2022-04-06T15:49:40
helm/hpcc/values.schema.json
10
2024-05-28T04:25:31.595363Z
{ "$schema": "https://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "auth": { "description": "Authentication method", "type": "string" }, "authNZ": { "additionalProperties": { "type": [ "object" ] }, "type": "object" }, "bundle": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "name": { "description": "The name of the bundle process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "compileOption": { "additionalProperties": false, "properties": { "cluster": { "description": "Cluster to apply option to", "type": "string" }, "name": { "description": "Compiler option name", "type": "string" }, "value": { "description": "Compiler option value", "type": [ "number", "string", "boolean" ] } }, "required": [ "name", "value" ], "type": "object" }, "componentCost": { "description": "component level costs", "properties": { "perCpu": { "description": "cost of a single cpu", "type": "number" } }, "type": "object" }, "dafilesrv": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "image": { "$ref": "#/definitions/image" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the dafilesrv process", "type": "string" }, "parallelRequestLimit": { "default": "20", "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service" ], "type": "object" }, "dali": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "name": { "description": "The name of the dali process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" }, "services": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" } }, "required": [ "name", "auth" ], "type": "object" }, "eclSecurity": { "properties": { "datafile": { "$ref": "#/definitions/eclSecurityValues" }, "embedded": { "$ref": "#/definitions/eclSecurityValues" }, "extern": { "$ref": "#/definitions/eclSecurityValues" }, "pipe": { "$ref": "#/definitions/eclSecurityValues" } }, "type": "object" }, "eclSecurityValues": { "enum": [ "deny", "allow", "allowSigned" ], "type": "string" }, "eclagent": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "jobMemory": { "$ref": "#/definitions/memory" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 100, "description": "Maximum number of workunits that can be active simultaneously", "minimum": 1, "type": "integer" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "type": { "description": "Use the hthor or roxie execution engine for eclagent queries", "enum": [ "hthor", "roxie" ], "type": "string" }, "useChildProcesses": { "description": "Launch each workunit as a child process rather than in its own container", "type": "boolean" } }, "required": [ "maxActive" ], "type": "object" }, "eclccserver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "childProcessTimeLimit": { "default": 10, "description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false", "type": "integer" }, "cost": { "$ref": "#/definitions/componentCost" }, "env": { "$ref": "#/definitions/env" }, "gitPlane": { "description": "The storage plane to check git repositories out to", "type": "string" }, "gitUsername": { "description": "The username to use for all remote repository access", "type": "string" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listen": { "items": { "type": "string" }, "type": "array" }, "logging": { "$ref": "#/definitions/logging" }, "maxActive": { "default": 4, "description": "Maximum number of compile jobs that can be active simultaneously", "minimum": 1, "type": "integer" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "options": { "items": { "$ref": "#/definitions/compileOption" }, "type": "array" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "useChildProcesses": { "description": "Launch each workunit compile as a child process rather than in its own container", "type": "boolean" } }, "required": [ "name", "maxActive" ], "type": "object" }, "eclscheduler": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the eclccserver process", "type": "string" }, "resources": { "$ref": "#/definitions/resources" } }, "required": [ "name" ], "type": "object" }, "egress": { "additionalProperties": false, "properties": { "kubeApiCidr": { "description": "IP range for kubectl API service", "type": "string" }, "kubeApiPort": { "description": "Port used for connections to kubectl API", "type": "integer" }, "kubeSystemLabel": { "description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace", "type": "string" }, "restricted": { "description": "Are any egress controls applied", "type": "boolean" } }, "type": "object" }, "env": { "items": { "properties": { "name": { "description": "Environment variable name", "type": "string" }, "value": { "description": "Environment variable value", "type": [ "number", "string", "boolean" ] } }, "type": "object" }, "type": "array" }, "esp": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "auth": { "$ref": "#/definitions/auth" }, "authNZ": { "$ref": "#/definitions/authNZ" }, "bindingInfo": { "description": "Customizable binding options", "type": "object" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "ldap": { "$ref": "#/definitions/ldap" }, "logging": { "$ref": "#/definitions/logging" }, "name": { "description": "The name of the esp process", "type": "string" }, "remoteClients": { "$ref": "#/definitions/remoteClients" }, "replicas": { "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "$ref": "#/definitions/service" } }, "required": [ "name", "service", "auth" ], "type": "object" }, "global": { "additionalProperties": false, "properties": { "cost": { "description": "default resource cost", "properties": { "currencyCode": { "description": "currency code (ISO 4217)", "maxLength": 3, "type": "string" }, "perCpu": { "description": "cost of a single cpu", "type": "number" }, "storageAtRest": { "description": "storage cost (GiB per month)", "type": "number" }, "storageReads": { "description": "cost per 10,000 read operations", "type": "number" }, "storageWrites": { "description": "cost per 10,000 write operations", "type": "number" } }, "type": "object" }, "defaultDataPath": { "type": "string" }, "defaultEsp": { "type": "string" }, "defaultMirrorPath": { "type": "string" }, "egress": { "$ref": "#/definitions/egress" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "logAccess": { "$ref": "#/definitions/logAccess" }, "logging": { "$ref": "#/definitions/logging" }, "metrics": { "description": "Global metrics configuration", "properties": { "sinks": { "$ref": "#/definitions/sinks" } }, "type": "object" }, "misc": { "description": "Miscellaneous settings", "oneOf": [ { "properties": { "postJobCommand": { "description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event", "type": "string" }, "postJobCommandViaSidecar": { "description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar", "type": "boolean" } }, "type": "object" }, { "type": "null" } ] }, "noResourceValidation": { "type": "boolean" }, "privileged": { "type": "boolean" }, "stubInstanceResources": { "$ref": "#/definitions/stubInstanceResources" }, "user": { "$ref": "#/definitions/user" }, "visibilities": { "additionalProperties": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "description": "Global visibilities configuration", "type": "object" } }, "type": "object" }, "hostGroup": { "additionalProperties": false, "oneOf": [ { "required": [ "name", "hosts" ] }, { "required": [ "name", "hostGroup" ] } ], "properties": { "count": { "description": "Number of hosts in the subset", "type": "integer" }, "delta": { "description": "Cycle offset to apply to the hosts", "type": "integer" }, "hostGroup": { "description": "Name of the hostgroup to create a subset of", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the host group process", "type": "string" }, "offset": { "description": "Offset of the first host within the group", "type": "integer" } }, "type": "object" }, "hostGroups": { "oneOf": [ { "items": { "$ref": "#/definitions/hostGroup" }, "type": "array" }, { "type": "null" } ] }, "image": { "additionalProperties": false, "properties": { "imagePullSecrets": { "type": "string" }, "name": { "default": "platform-core", "type": "string" }, "pullPolicy": { "enum": [ "IfNotPresent", "Always", "Never" ], "type": "string" }, "root": { "default": "hpccsystems", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "ingress": { "items": { "additionalProperties": { "items": { "type": "object" }, "type": "array" } }, "type": "array" }, "issuer": { "properties": { "kind": { "enum": [ "Issuer", "ClusterIssuer" ], "type": "string" }, "name": { "description": "The name of the issuer which will be referenced in certificate objects", "type": "string" }, "spec": { "description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/", "type": "object" } }, "required": [ "name" ], "type": "object" }, "ldap": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "adminGroupName": { "description": "The Active Directory group containing HPCC Administrators", "type": "string" }, "cacheTimeout": { "description": "Time in minutes after which the cached security information should be reloaded", "type": "integer" }, "checkScopeScans": { "description": "Only return iterated logical file metadata for files that user has scope permission to access", "type": "boolean" }, "description": { "description": "Description of this Active Directory Server component", "type": "string" }, "filesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server", "type": "string" }, "groupsBasedn": { "description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server", "type": "string" }, "hpccAdminSecretKey": { "description": "The optional key name to be used to look up the HPCC Administrator account Username/Password", "type": "string" }, "hpccAdminVaultId": { "description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey", "type": "string" }, "ldapAddress": { "description": "LDAP Server IP address(es), comma separated", "type": "string" }, "ldapAdminSecretKey": { "description": "The key name to be used to look up the Active Directory Administrator account Username/Password", "type": "string" }, "ldapAdminVaultId": { "description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey", "type": "string" }, "ldapPort": { "description": "The port of the nonsecure Active Directory server", "type": "integer" }, "ldapProtocol": { "description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL", "type": "string" }, "ldapSecurePort": { "description": "The secure port of the secure Active Directory server", "type": "integer" }, "ldapTimeoutSecs": { "description": "The maximum number of seconds to wait for most Active Directory calls", "type": "integer" }, "maxConnections": { "description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)", "type": "integer" }, "passwordExpirationWarningDays": { "description": "Within this time period, ECLWatch displays a warning about pending password expiration", "type": "integer" }, "resourcesBasedn": { "description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server", "type": "string" }, "servertype": { "description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")", "type": "string" }, "sharedCache": { "description": "Use a single, shared LDAP cache", "type": "boolean" }, "systemBasedn": { "description": "The base distinguished name of the Active Directory Administrator", "type": "string" }, "usersBasedn": { "description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server", "type": "string" }, "workunitsBasedn": { "description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server", "type": "string" } }, "required": [ "ldapAddress" ], "type": "object" }, "logAccess": { "description": "Remote log access information", "properties": { "connection": { "$ref": "#/definitions/logAccessConnection" }, "logMaps": { "description": "A list of log maps", "items": { "$ref": "#/definitions/logMap" }, "type": "array" }, "name": { "type": "string" }, "type": { "description": "Name of HPCC LogAccess plugin type such as 'elasticstack'", "type": "string" } }, "type": "object" }, "logAccessConnection": { "description": "Connection information for target remote log access", "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "logMap": { "description": "Provides log-store mapping to searchable HPCC log columns", "properties": { "searchColumn": { "description": "Name of column mapped to HPCC log entry column", "type": "string" }, "storeName": { "description": "Name of container housing mapped HPCC log column", "type": "string" }, "timeStampColumn": { "description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)", "type": "string" }, "type": { "description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields", "enum": [ "global", "workunits", "components", "audience", "class" ], "type": "string" } }, "type": "object" }, "logging": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "audiences": { "description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "classes": { "description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -", "type": "string" }, "detail": { "description": "Log output verbosity", "type": "integer" } }, "type": "object" }, "maxStartupTime": { "description": "The time to wait before startup probing fails (in seconds). Default 300", "type": "integer" }, "memory": { "additionalProperties": false, "properties": { "maxMemPercentage": { "description": "The default maximum percentage of resource memory to dedicate to HPCC", "type": "number" }, "query": { "description": "The amount of overall resourced memory to dedicate to the query", "type": "string" }, "thirdParty": { "description": "The amount of overall resource memory to reserve for 3rd party use", "type": "string" } }, "type": "object" }, "minStartupTime": { "description": "The time to wait before initiating startup probing (in seconds). Default 0", "type": "integer" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "type": "object" }, "placement": { "properties": { "affinity": { "type": "object" }, "nodeSelector": { "$ref": "#/definitions/nodeSelector" }, "schedulerName": { "type": "string" }, "tolerations": { "$ref": "#/definitions/tolerations" }, "topologySpreadConstraints": { "items": { "$ref": "#/definitions/topologySpreadConstraint" }, "type": "array" } }, "type": "object" }, "remoteClients": { "items": { "properties": { "name": { "description": "Remote client name", "type": "string" } }, "type": "object" }, "type": "array" }, "remoteStorage": { "description": "remote storage definitions", "items": { "$ref": "#/definitions/remoteStorageEntry" }, "type": "array" }, "remoteStorageEntry": { "additionalProperties": false, "description": "information about an individual remote storage definition", "oneOf": [ { "required": [ "name", "service", "planes" ] }, { "required": [ "name", "service", "useDafilesrv" ] } ], "properties": { "name": { "description": "the name of the remote storage definition", "type": "string" }, "planes": { "description": "mapping of remote planes to local planes", "items": { "properties": { "local": { "description": "The name of the local plane to map to", "type": "string" }, "remote": { "description": "The name of the remote plane to map from", "type": "string" } }, "type": "object" }, "type": "array" }, "secret": { "description": "the name of the secret containing the certificates to connect to the service", "type": "string" }, "service": { "description": "the remote DFS service", "type": "string" }, "useDafilesrv": { "const": true } }, "type": "object" }, "resources": { "type": "object" }, "roxie": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "agentQueryReleaseDelaySeconds": { "default": 60, "description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.", "minimum": 0, "type": "integer" }, "agentThreads": { "default": 30, "description": "Number of threads processing agent requests", "minimum": 0, "type": "integer" }, "allFilesDynamic": { "default": false, "description": "If enabled, files will be resolved per-query and not locked between queries", "type": "boolean" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "backgroundCopyClass": { "default": "none", "description": "Specify an IONICE class for the background copy thread.", "enum": [ "none", "best-effort", "idle" ], "type": "string" }, "backgroundCopyPrio": { "default": 0, "description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.", "type": "integer" }, "blindLogging": { "default": false, "description": "Suppress all logging of any data or query text", "type": "boolean" }, "blobCacheMem": { "default": 0, "description": "Size (in Mb) of blob index page cache", "minimum": 0, "type": "integer" }, "callbackRetries": { "default": 3, "description": "Number of retries before callbacks from agents to server are aborted", "minimum": 1, "type": "integer" }, "callbackTimeout": { "default": 5000, "description": "Timeout (in ms) before callbacks from agents to server are resent", "minimum": 0, "type": "integer" }, "certificate": { "description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.", "type": "string" }, "channelResources": { "$ref": "#/definitions/resources" }, "checkCompleted": { "default": true, "description": "Check pending replies when agent gets a retry request", "type": "boolean" }, "checkFileDate": { "default": true, "description": "Compare file dates of physical files with the information in DFS.", "type": "boolean" }, "collectFactoryStatistics": { "default": true, "description": "Accumulate summary statistics for all queries", "type": "boolean" }, "copyResources": { "default": true, "description": "Copies any missing data files/keys from the position they were in when query was deployed.", "type": "boolean" }, "dafilesrvLookupTimeout": { "default": 10000, "description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list", "minimum": 0, "type": "integer" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "defaultConcatPreload": { "default": 0, "description": "Default concat preload", "minimum": 0, "type": "integer" }, "defaultFetchPreload": { "default": 0, "description": "Default fetch preload", "minimum": 0, "type": "integer" }, "defaultFullKeyedJoinPreload": { "default": 0, "description": "Default full keyed join preload", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultHighPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultKeyedJoinPreload": { "default": 0, "description": "Default keyed join preload", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultLowPriorityTimeWarning": { "default": 0, "description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultMemoryLimit": { "default": 0, "description": "Maximum amount of memory available for row data in any single active query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultParallelJoinPreload": { "default": 0, "description": "Default parallel join preload", "minimum": 0, "type": "integer" }, "defaultPrefetchProjectPreload": { "default": 10, "description": "Default prefetch value for PROJECT,PREFETCH activity", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeLimit": { "default": 0, "description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultSLAPriorityTimeWarning": { "default": 5000, "description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)", "minimum": 0, "type": "integer" }, "defaultStripLeadingWhitespace": { "default": true, "description": "Default value for stripping leading whitespace in input XML values", "type": "boolean" }, "directAccessPlanes": { "description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane", "items": { "type": "string" }, "type": "array" }, "doIbytiDelay": { "default": true, "description": "Enables the IBYTI delay logic in the agents.", "type": "boolean" }, "enableHeartBeat": { "default": true, "description": "Enable HeartBeat messages to roxiepipe clients", "type": "boolean" }, "encryptionInTransit": { "default": false, "description": "Encrypt traffic between Roxie nodes.", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "fastLaneQueue": { "default": true, "description": "Enable special fast-lane queue for simple queries.", "type": "boolean" }, "fieldTranslationEnabled": { "default": "payload", "description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only", "enum": [ "false", "true", "payload" ] }, "fileTimeFuzzySeconds": { "default": 0, "description": "Ignore mismatched file dates of up to this amount", "type": "integer" }, "flushJHtreeCacheOnOOM": { "default": true, "description": "Should the index node memory allocation flush the cache and retry if memory allocation fails", "type": "boolean" }, "heapRetainMemory": { "default": false, "description": "Retain and do not return unused memory to the operating system.", "type": "boolean" }, "heapUseHugePages": { "default": false, "description": "Allow roxie to use memory from huge pages if they have been configured.", "type": "boolean" }, "heapUseTransparentHugePages": { "default": true, "description": "Allow roxie to use memory from transparent huge pages.", "type": "boolean" }, "highTimeout": { "default": 2000, "description": "Timeout (in ms) before high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "httpCallerIdHeader": { "default": "HPCC-Caller-Id", "description": "HTTP Header field to use for sending and receiving CallerId", "type": "string" }, "httpGlobalIdHeader": { "default": "HPCC-Global-Id", "description": "HTTP Header field to use for sending and receiving GlobalId", "type": "string" }, "ignoreFileDateMismatches": { "default": false, "description": "Ignore mismatched file dates on local files", "type": "boolean" }, "ignoreMissingFiles": { "default": false, "description": "Ignore missing files", "type": "boolean" }, "ignoreOrphans": { "default": true, "description": "Treat out-of-date local files as if they were not present.", "type": "boolean" }, "image": { "$ref": "#/definitions/image" }, "indexReadChunkSize": { "default": 60000, "description": "Break up results from indexRead (and other remote activities) every N bytes", "minimum": 0, "type": "integer" }, "initIbytiDelay": { "default": 50, "description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.", "minimum": 0, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lazyOpen": { "default": false, "description": "Delay opening files until first use.", "type": "boolean" }, "leafCacheMem": { "default": 50, "description": "Size (in Mb) of leaf index page cache", "minimum": 0, "type": "integer" }, "linuxYield": { "default": false, "description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines", "type": "boolean" }, "localFilesExpire": { "default": -1, "description": "Period (in ms) of inactivity before a local datafile handle is closed", "type": "integer" }, "lockSuperFiles": { "default": false, "description": "If enabled, superfiles will be locked while queries that use them are loaded", "type": "boolean" }, "logFullQueries": { "default": false, "description": "Log full text (unless blindLogging) and resource usage of all queries received ", "type": "boolean" }, "logging": { "$ref": "#/definitions/logging" }, "lowTimeout": { "default": 10000, "description": "Timeout (in ms) before low priority requests are resent to agents", "minimum": 0, "type": "integer" }, "maxBlockSize": { "default": 10000000, "description": "Max size of block read from client socket", "minimum": 0, "type": "integer" }, "maxHttpConnectionRequests": { "default": 0, "description": "Max number of query requests per persistent http connection", "minimum": 0, "type": "integer" }, "maxHttpKeepAliveWait": { "default": 5000, "description": "Max number of miliseconds to wait for additional requests on a persistent http connection", "minimum": 0, "type": "integer" }, "maxLocalFilesOpen": { "default": 4000, "description": "Maximum number of local files to keep open", "minimum": 0, "type": "integer" }, "maxLockAttempts": { "default": 5, "description": "Number of retries to get lock for global queries", "minimum": 0, "type": "integer" }, "maxRemoteFilesOpen": { "default": 1000, "description": "Maximum number of remote files to keep open", "minimum": 0, "type": "integer" }, "maxStartupTime": { "$ref": "#/definitions/maxStartupTime" }, "memTraceLevel": { "default": 1, "description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "memTraceSizeLimit": { "default": 10, "description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)", "minimum": 0, "type": "integer" }, "memoryStatsInterval": { "default": 60, "description": "Interval (in seconds) between reports on Roxie heap usage", "minimum": 0, "type": "integer" }, "minLocalFilesOpen": { "default": 2000, "description": "Minimum number of local files to keep open", "minimum": 0, "type": "integer" }, "minRemoteFilesOpen": { "default": 500, "description": "Minimum number of remote files to keep open", "minimum": 0, "type": "integer" }, "minStartupTime": { "$ref": "#/definitions/minStartupTime" }, "miscDebugTraceLevel": { "default": 0, "description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "mtuPayload": { "default": 1400, "description": "Set higher than 1400 for networks with a larger MTU.", "maximum": 9000, "minimum": 1400, "type": "integer" }, "mysqlCacheCheckPeriod": { "default": 10000, "description": "Time to wait (ms) between checking if any cached MySQL connections can be closed", "minimum": 0, "type": "integer" }, "mysqlCacheTimeoutPeriod": { "default": 60000, "description": "Time to wait (ms) before closing a cached MySQL connection", "minimum": 0, "type": "integer" }, "mysqlConnectionCacheSize": { "default": 10000, "description": "Number of MySQL connections to hold in cache", "minimum": 0, "type": "integer" }, "name": { "description": "The name of the roxie process", "type": "string" }, "nodeCacheMem": { "default": 100, "description": "Size (in Mb) of non-leaf index page cache", "minimum": 0, "type": "integer" }, "parallelAggregate": { "default": 0, "description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates", "minimum": 0, "type": "integer" }, "parallelQueryLoadThreads": { "default": 0, "description": "Use up to n multiple threads for initial query loading", "minimum": 0, "type": "integer" }, "perChannelFlowLimit": { "default": 10, "description": "Number of pending queries permitted per channel (per active activity) before blocking", "minimum": 1, "type": "integer" }, "pingInterval": { "default": 60, "description": "Interval (in seconds) between Roxie server ping tests", "minimum": 0, "type": "integer" }, "preabortIndexReadsThreshold": { "default": 100, "description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value", "minimum": 0, "type": "integer" }, "preabortKeyedJoinsThreshold": { "default": 100, "description": "Use seek to precheck limits on keyed joins if limit greater than this value", "minimum": 0, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "preload": { "description": "Preloaded plugins", "items": { "type": "string" }, "type": "array" }, "preloadOnceData": { "default": true, "description": "Evaluate : ONCE sections of queries at query load time", "type": "boolean" }, "prestartAgentThreads": { "default": false, "description": "Prestart agent worker threads at startup", "type": "boolean" }, "reloadRetriesSuspended": { "default": true, "description": "Retry loading of suspended queries whenever QuerySet reloads", "type": "boolean" }, "remoteFilesExpire": { "default": 3600000, "description": "Period (in ms) of inactivity before a remote datafile handle is closed", "minimum": 0, "type": "integer" }, "resources": { "$ref": "#/definitions/resources" }, "serverResources": { "$ref": "#/definitions/resources" }, "serverThreads": { "default": 30, "description": "Default number of threads processing Roxie server requests (if not specified on service)", "minimum": 0, "type": "integer" }, "services": { "description": "Roxie query services", "items": { "$ref": "#/definitions/roxieservice" }, "type": "array" }, "simpleLocalKeyedJoins": { "default": true, "description": "Enable single-threaded local keyed joins", "type": "boolean" }, "slaTimeout": { "default": 2000, "description": "Timeout (in ms) before SLA high priority requests are resent to agents", "minimum": 0, "type": "integer" }, "soapTraceLevel": { "default": 1, "description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "socketCheckInterval": { "default": 5000, "description": "Interval (in milliseconds) between checks that client socket is still open", "minimum": 0, "type": "integer" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "statsExpiryTime": { "default": 3600, "description": "Time (in seconds) that detailed reporting stats are kept", "minimum": 0, "type": "integer" }, "topoServer": { "$ref": "#/definitions/toposerver" }, "totalMemoryLimit": { "default": "1G", "description": "Maximum amount of memory available for row data in all active queries", "type": "string" }, "traceEnabled": { "default": false, "description": "TRACE activity output enabled by default (can be overridden in workunit or query)", "type": "boolean" }, "traceLevel": { "default": 1, "description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)", "minimum": 0, "type": "integer" }, "traceLimit": { "default": 10, "description": "Number of rows output by TRACE activity", "minimum": 0, "type": "integer" }, "traceTranslations": { "default": true, "description": "Trace record layout translations to log file", "type": "boolean" }, "trapTooManyActiveQueries": { "default": true, "description": "should an SNMP trap get sent when too many active query error occurs", "type": "boolean" }, "udpAdjustThreadPriorities": { "default": false, "description": "Should UDP socket reading threads operate at elevated priority", "type": "boolean" }, "udpAgentBufferSize": { "default": 262142, "description": "Controls the read socket buffer size of the UDP agent read sockets", "minimum": 0, "type": "integer" }, "udpFlowSocketsSize": { "default": 131072, "description": "Controls the read socket buffer size of the UDP layer flow control sockets", "minimum": 0, "type": "integer" }, "udpLocalWriteSocketSize": { "default": 1024000, "description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)", "minimum": 0, "type": "integer" }, "udpOutQsPriority": { "default": 0, "description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)", "minimum": 0, "type": "integer" }, "udpQueueSize": { "default": 100, "description": "UDP transport layer receive queue size", "minimum": 0, "type": "integer" }, "udpResendLostPackets": { "default": true, "description": "UDP transport layer resend lost packets", "type": "boolean" }, "udpSendQueueSize": { "default": 50, "description": "UDP transport layer send queue size", "minimum": 0, "type": "integer" }, "udpStatsReportInterval": { "default": 60000, "description": "UDP transport layer stats reporting interval", "minimum": 0, "type": "integer" }, "udpTraceLevel": { "default": 1, "description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)", "minimum": 0, "type": "integer" }, "useMemoryMappedIndexes": { "default": false, "description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.", "type": "boolean" }, "useRemoteResources": { "default": false, "description": "Reads any missing data files/keys from the position they were in when deployed.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "roxieservice": { "additionalProperties": false, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "listenQueue": { "type": "integer" }, "name": { "type": "string" }, "numThreads": { "type": "integer" }, "port": { "description": "The local port used by the pod (same as servicePort if not specified)", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "tls": { "description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.", "type": "boolean" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "name", "servicePort" ], "type": "object" }, "sasha-coalescer": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "minDeltaSize": { "description": "Coalescing will only begin, if the delta size is above this threshold (K)", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfurecovery-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "type": "object" }, { "type": "null" } ] }, "sasha-dfuwu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "cutoff": {}, "disabled": {}, "env": {}, "image": {}, "interval": {}, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sasha-file-expiry": { "oneOf": [ { "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/sashacommon" } ], "properties": { "annotations": {}, "at": {}, "disabled": {}, "expiryDefault": { "default": "14", "description": "Default number of days to delete unused standard files that are flagged with EXPIRY", "type": "integer" }, "image": {}, "interval": {}, "labels": {}, "persistExpiryDefault": { "default": "7", "description": "Default number of days to delete unused persist files", "type": "integer" }, "plane": {}, "resources": {}, "service": {}, "throttle": {}, "user": { "description": "A username authorized to access and remove expired files", "type": "string" } }, "type": "object" }, { "type": "null" } ] }, "sasha-limitcutoff": { "properties": { "cutoff": { "default": "4", "description": "minimum age (days)", "type": "integer" }, "limit": { "default": "20", "description": "threshold before removal starts (0 disables)", "type": "integer" } }, "type": "object" }, "sasha-wu-archiver": { "oneOf": [ { "allOf": [ { "$ref": "#/definitions/sashacommon" }, { "$ref": "#/definitions/sasha-limitcutoff" }, { "additionalProperties": false, "properties": { "annotations": {}, "at": {}, "backup": { "default": "0", "description": "minimum workunit age to backup (days, 0 disables)", "type": "integer" }, "cutoff": {}, "disabled": {}, "duration": { "default": "0", "description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)", "type": "integer" }, "env": {}, "image": {}, "interval": {}, "keepResultFiles": { "default": "false", "description": "option to keep result files owned by workunits after workunit is archived", "type": "boolean" }, "labels": {}, "limit": {}, "plane": {}, "resources": {}, "retryinterval": { "default": "7", "description": "minimal time before retrying archive of failed WorkUnits (days)", "type": "integer" }, "service": {}, "throttle": {} } } ], "required": [ "plane" ], "type": "object" }, { "type": "null" } ] }, "sashacommon": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "at": { "default": "* * * * *", "type": "string" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "image": { "$ref": "#/definitions/image" }, "interval": { "default": 1, "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "plane": { "description": "which storage plane to store the sasha data on", "type": "string" }, "resources": { "$ref": "#/definitions/resources" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" } }, "required": [ "servicePort" ], "type": "object" }, "throttle": { "description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)", "type": "integer" } }, "type": "object" }, "sashaservice": { "oneOf": [ { "additionalProperties": false, "description": "sasha services", "properties": { "coalescer": { "$ref": "#/definitions/sasha-coalescer" }, "dfurecovery-archiver": { "$ref": "#/definitions/sasha-dfurecovery-archiver" }, "dfuwu-archiver": { "$ref": "#/definitions/sasha-dfuwu-archiver" }, "disabled": { "type": "boolean" }, "file-expiry": { "$ref": "#/definitions/sasha-file-expiry" }, "wu-archiver": { "$ref": "#/definitions/sasha-wu-archiver" } }, "type": "object" }, { "type": "null" } ] }, "secrets": { "oneOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "security": { "properties": { "eclSecurity": { "$ref": "#/definitions/eclSecurity" }, "mtls": { "default": true, "description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true", "type": "boolean" } }, "type": "object" }, "service": { "description": "Service properties", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "application": { "description": "Application name", "type": "string" }, "ingress": { "$ref": "#/definitions/ingress" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "loadBalancerSourceRanges": { "description": "A list of CIDR ranges that you would like to allow for access to the Service", "items": { "type": "string" }, "type": "array" }, "port": { "default": 8880, "description": "The local port used by the pod", "type": "integer" }, "servicePort": { "description": "The port that this service will be exposed on", "type": "integer" }, "visibility": { "description": "Should this service be exposed outside the cluster, locally or to the internet", "type": "string" } }, "required": [ "servicePort", "visibility" ], "type": "object" }, "sink": { "description": "Definition of a metric sink", "properties": { "name": { "description": "Name for the sink, must be unique for the component", "type": "string" }, "settings": { "description": "Settings specific to the sink", "type": "object" }, "type": { "description": "The defined metric sink type", "type": "string" } }, "required": [ "type", "name" ], "type": "object" }, "sinks": { "items": { "$ref": "#/definitions/sink" }, "type": "array" }, "storagePlane": { "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "aliases": { "description": "A list of additional ways of accessing the data, along with the reasons why", "items": { "$ref": "#/definitions/storagePlaneAlias" }, "type": "array" }, "category": { "description": "the category this plane is used for, e.g. lz, data", "enum": [ "data", "lz", "dali", "sasha", "dll", "spill", "temp", "git", "remote", "debug" ], "type": "string" }, "cost": {}, "defaultSprayParts": { "description": "Number of parts sprayed by default", "type": "integer" }, "disabled": { "description": "disable this plane definition", "type": "boolean" }, "forcePermissions": { "type": "boolean" }, "hostGroup": {}, "hosts": {}, "includeDeviceInPath": { "description": "is a directory based on the part number appended to the path. May not be needed", "type": "boolean" }, "name": { "description": "the name of the storage plane", "type": "string" }, "numDevices": { "description": "optional number of devices in the storage plane (default 1)", "type": "integer" }, "numMounts": {}, "prefix": {}, "pvc": {}, "replication": { "description": "which planes (if any) the data is replicated onto (primarily bare metal)", "items": { "type": "string" }, "type": "array" }, "secret": {}, "storageClass": { "type": "string" }, "storageMode": { "type": "string" }, "storageSize": { "type": "string" }, "subDirPerFilePart": { "default": true, "description": "Place each logical file part in its own subdirectory", "type": "boolean" }, "subPath": {}, "umask": {} } } ], "description": "information about an individual storage plane", "required": [ "name", "prefix", "category" ], "type": "object" }, "storagePlaneAlias": { "$comment": "The following properties are required for providing an alternative path to a data plane", "allOf": [ { "$ref": "#/definitions/storagePlaneCommon" }, { "additionalProperties": false, "properties": { "cost": {}, "hostGroup": {}, "hosts": {}, "mode": { "description": "A list of access modes the engines would use to select this alias", "items": { "enum": [ "write", "sequential", "random", "api" ], "type": "string" }, "type": "array" }, "name": { "description": "the name of the alias", "type": "string" }, "numMounts": {}, "prefix": {}, "pvc": {}, "secret": {}, "subPath": {}, "umask": {} }, "required": [ "name", "mode", "prefix" ] } ] }, "storagePlaneCommon": { "$comment": "The following properties make sense either on a storage plane or an an alias. For that reason they do not include properties that are used to create implement pvcs e.g. storageClass. All new entries must be added as null entries in storagePlane and storagePlaneAlias", "properties": { "cost": { "description": "Costs associated with the storage and use of the plane", "properties": { "storageAtRest": { "description": "Storage cost (GiB/month)", "type": "number" } }, "type": "object" }, "hostGroup": { "description": "optional name of the host group (for bare metal storage)", "type": "string" }, "hosts": { "description": "a list of host names", "items": { "type": "string" }, "type": "array" }, "numMounts": { "description": "the number of mounts for this pvc - defaults to numDevices", "type": "integer" }, "prefix": { "description": "either the path for a local mount, or the url prefix", "type": "string" }, "pvc": { "description": "optional name of the persistent volume claim for this plane", "type": "string" }, "secret": { "description": "optional name of any secret required to access this storage plane", "type": "string" }, "subPath": { "description": "optional subdirectory within the mount directory", "type": "string" }, "umask": { "description": "file creation mask (used by despray)", "type": "string" } } }, "storagePlanes": { "description": "storage plane definitions", "items": { "$ref": "#/definitions/storagePlane" }, "type": "array" }, "stubInstanceResources": { "description": "resource definitions per instance for stub components", "properties": { "additionalProperties": false, "cpu": { "default": "50m", "description": "default per stub instance milli cpu requirements", "type": "string" }, "memory": { "default": "200Mi", "description": "default per stub instance memory requirements", "type": "string" } }, "type": "object" }, "thor": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "cost": { "$ref": "#/definitions/componentCost" }, "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "eclAgentMemory": { "$ref": "#/definitions/memory" }, "eclAgentReplicas": { "description": "Number of eclagent replicas", "minimum": 1, "type": "integer" }, "eclAgentResources": { "$ref": "#/definitions/resources" }, "eclAgentType": { "description": "eclagent engine type", "enum": [ "hthor", "roxie" ] }, "eclAgentUseChildProcesses": { "description": "Use processes instead of pods per job (eclagent)", "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "expert": { "description": "Custom internal options usually reserved for internal testing", "type": "object" }, "image": { "$ref": "#/definitions/image" }, "keepJobs": { "description": "For debugging purposes. Choose whether to keep jobs after execution", "enum": [ "none", "podfailures", "all" ] }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "lingerPeriod": { "description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute", "minimum": 1, "type": "integer" }, "logging": { "$ref": "#/definitions/logging" }, "managerMemory": { "$ref": "#/definitions/memory" }, "managerResources": { "$ref": "#/definitions/resources" }, "maxGraphs": { "description": "The maximum number of Thor graphs that be run concurrently", "minimum": 1, "type": "integer" }, "maxJobs": { "description": "The maximum number of jobs that can be run concurrenly", "minimum": 1, "type": "integer" }, "multiJobLinger": { "description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job", "type": "boolean" }, "name": { "description": "The name of the thor process", "type": "string" }, "numWorkers": { "description": "The number of worker pods", "minimum": 1, "type": "integer" }, "numWorkersPerPod": { "default": 1, "description": "The number of workers to place per pod (must be a factor of numWorkers)", "minimum": 1, "type": "integer" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" }, "thorAgentReplicas": { "description": "Number of thoragent replicas", "minimum": 1, "type": "integer" }, "workerMemory": { "$ref": "#/definitions/memory" }, "workerResources": { "$ref": "#/definitions/resources" } }, "required": [ "name", "maxJobs", "maxGraphs" ], "type": "object" }, "toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "tolerations": { "items": { "$ref": "#/definitions/toleration" }, "type": "array" }, "topologySpreadConstraint": { "properties": { "labelSelector": { "description": "labelSelector is used to find matching Pods", "type": "object" }, "maxSkew": { "description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero", "type": "integer" }, "topologyKey": { "description": "is the key of node labels", "type": "string" }, "whenUnsatisfiable": { "description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint", "enum": [ "DoNotSchedule", "ScheduleAnyway" ], "type": "string" } }, "type": "object" }, "toposerver": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "logging": { "$ref": "#/definitions/logging" }, "port": { "type": "integer" }, "replicas": { "type": "integer" }, "traceLevel": { "type": "integer" } }, "type": "object" }, "user": { "additionalProperties": false, "properties": { "gid": { "default": 10001, "type": "integer" }, "uid": { "default": 10000, "type": "integer" } }, "type": "object" }, "vault": { "additionalProperties": false, "description": "information about an individual vault", "properties": { "client-secret": { "description": "optional name of kubernetes secret that will provide the vault client token", "type": "string" }, "kind": { "enum": [ "kv-v2", "kv-v1" ], "type": "string" }, "name": { "description": "the name of the vault", "type": "string" }, "url": { "description": "the url used to access the vault", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "vaultCategory": { "description": "set of vaults under a given category", "oneOf": [ { "items": { "$ref": "#/definitions/vault" }, "type": "array" }, { "type": "null" } ] } }, "properties": { "bundles": { "description": "bundles", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }, "certificates": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "issuers": { "properties": { "local": { "$ref": "#/definitions/issuer" }, "public": { "$ref": "#/definitions/issuer" } }, "type": "object" } }, "type": "object" }, "dafilesrv": { "description": "dafilesrv process", "items": { "$ref": "#/definitions/dafilesrv" }, "type": "array" }, "dali": { "description": "dali process", "items": { "$ref": "#/definitions/dali" }, "maxItems": 1, "minItems": 1, "type": "array" }, "dfuserver": { "description": "dfuserver process", "items": { "additionalProperties": { "type": [ "integer", "string", "boolean" ] }, "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "disabled": { "type": "boolean" }, "env": { "$ref": "#/definitions/env" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "maxJobs": { "type": "integer" }, "name": { "description": "The name of the dfuserver process", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "eclagent": { "description": "eclagent process", "items": { "allOf": [ { "$ref": "#/definitions/eclagent" }, { "dataPlane": { "description": "The default storage plane to write data files to", "type": "string" }, "name": { "description": "The name of the eclagent process", "type": "string" }, "prefix": { "description": "The (optional) file prefix to add to relative filenames", "type": "string" }, "required": [ "name" ], "spillPlane": { "description": "The storage plane to write spill files to", "type": "string" } } ] }, "type": "array" }, "eclccserver": { "description": "eclccserver process", "items": { "$ref": "#/definitions/eclccserver" }, "type": "array" }, "eclscheduler": { "description": "eclscheduler process", "items": { "$ref": "#/definitions/eclscheduler" }, "type": "array" }, "esp": { "description": "esp process", "items": { "$ref": "#/definitions/esp" }, "type": "array" }, "global": { "$ref": "#/definitions/global" }, "placements": { "items": { "properties": { "placement": { "$ref": "#/definitions/placement" }, "pods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "roxie": { "description": "roxie process", "items": { "$ref": "#/definitions/roxie" }, "type": "array" }, "sasha": { "$ref": "#/definitions/sashaservice", "description": "sasha services", "type": "object" }, "secrets": { "additionalProperties": false, "description": "configuration for secrets accessed by the components", "properties": { "authn": { "$ref": "#/definitions/secrets" }, "codeSign": { "$ref": "#/definitions/secrets" }, "codeVerify": { "$ref": "#/definitions/secrets" }, "ecl": { "$ref": "#/definitions/secrets" }, "git": { "$ref": "#/definitions/secrets" }, "storage": { "$ref": "#/definitions/secrets" }, "system": { "$ref": "#/definitions/secrets" }, "timeout": { "type": "integer" } }, "type": "object" }, "security": { "$ref": "#/definitions/security" }, "storage": { "additionalProperties": false, "properties": { "hostGroups": { "$ref": "#/definitions/hostGroups" }, "planes": { "$ref": "#/definitions/storagePlanes" }, "remote": { "$ref": "#/definitions/remoteStorage" } }, "type": "object" }, "thor": { "description": "thor process", "items": { "$ref": "#/definitions/thor" }, "type": "array" }, "vaults": { "additionalProperties": false, "description": "configuration for vaults accessed by the components", "properties": { "authn": { "$ref": "#/definitions/vaultCategory" }, "codeSign": { "$ref": "#/definitions/vaultCategory" }, "codeVerify": { "$ref": "#/definitions/vaultCategory" }, "ecl": { "$ref": "#/definitions/vaultCategory" }, "ecl-user": { "$ref": "#/definitions/vaultCategory" }, "esp": { "$ref": "#/definitions/vaultCategory" }, "storage": { "$ref": "#/definitions/vaultCategory" }, "timeout": { "type": "integer" } }, "type": "object" } }, "required": [ "dali" ], "title": "Values", "type": "object" }
Apache-2.0
en